diff --git a/README.md b/README.md index a8930bed1698b7903d228820e0359311dd4e37e1..07609d61d1db7ffe943c91feeef4786cd4692fc1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,52 @@ -# KRINI +# Krini -# NOTE +TODO: Description -Please push to the dev branch +## Installation -`git push origin dev` -Alternatively use +## Getting Started -`git branch --set-upstream origin dev` +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. + +### Prerequisites + +TODO: Dependencies etc + +### Installing + +Install wrapper repository including associated submodules + +```bash +git clone --recursive ssh://git@git.scicore.unibas.ch:2222/krini/krini.git +``` + +## Running the tests + +TODO: Instructions / subsections for unit, e2e tests etc + +## Deployment + +TODO: Notes + +## Built With + +* [Django](http://www.dropwizard.io/1.0.2/docs/) +* [Django REST framework](http://www.django-rest-framework.org/) +* [Angular](https://angular.io/) +* [Docker](https://www.docker.com/) + +## Authors + +* **Alexander Kanitz** - *Initial work* - [GitLab](https://git.scicore.unibas.ch/kanitz) + +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. + +## License + +This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for +details. + +## Acknowledgments + +* TODO