diff --git a/README.md b/README.md index 7985b078..878d1440 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,27 @@ Contributing [guidelines]: .github/CONTRIBUTING.rst [getting-started]: https://in-junction.readthedocs.io/en/latest/development/getting-started.html + + +
To setup this on your local system. Follow the steps:
+To start with you have to setup docker on your local system. For that you need docker-compose to be installed on your system.
+brew install docker-compose
for macsudo apt install docker-compose
for linuxecho $PATH
+If /usr/local/bin
is not in your path, you need to add it.echo 'export PATH="$PATH:/usr/local/bin"' >> ~/.zshrc
+source ~/.zshrc
+After accomplishing these steps you need to login into your docker account
+docker login
docker login username <__username__>
After successfully following these steps you can refer to the docs[getting-started] for further execution of the application
License ------- This software is licensed under The MIT License(MIT). See the [LICENSE][LICENSE] file in the top distribution directory for the full license text. [LICENSE]: https://github.com/pythonindia/junction/blob/master/LICENSE + + + + + +