diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..a6e2f6726 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,5 @@ +version: 2 +python: + version: 3 + install: + - requirements: docs/rtd-requirements.txt diff --git a/README.md b/README.md index 2f67b9077..b661cb1e3 100644 --- a/README.md +++ b/README.md @@ -11,27 +11,25 @@ and managing kegged beverages. Super quick start instructions: ``` -$ mkvirtualenv kb -(kb) $ pip install kegbot -(kb) $ setup-kegbot.py -(kb) $ kegbot runserver +$ cd git/kegbot-server +$ pipenv install +$ pipenv shell +(kegbot-server) +$ KEGBOT_DATABASE_URL=mysql://root@localhost/kegbot_dev kegbot runserver Development server is running at http://localhost:8000/ ``` -For much more detail, see the complete [Kegbot Server documentation](http://kegbot.org/docs/server/). +For much more detail, see the complete [Kegbot Server documentation](https://kegbot-server.readthedocs.io/en/latest/). ## Documentation and Help -Please see our main website, http://kegbot.org/, for -[documentation](http://kegbot.org/docs), the -[Kegbot Forum](http://kegbot.org/kegbb/), and the -[Kegbot Blog](http://kegbot.org/blog/). - -You can also find us on **#kegbot** on freenode IRC. - -You should definitely follow [@kegbot](http://twitter.com/kegbot) on -Twitter, all the cool kids are. +* Main project page: https://kegbot.org +* Documentation: https://kegbot-server.readthedocs.io/en/latest/ +* Discussion forum: https://forum.kegbot.org/ +* Discusion Slack group: [Slack link](https://join.slack.com/t/kegbot/shared_invite/enQtMjk4NjI4NTMyMzUzLTQwYzBhNzk2NDg2NjcwZjViOTIxY2E2ZmFmY2NkOTU0Y2ZiNzYwMmFhNGYzZDY0YjU2MmQ3Mjk3ZGMwYTNhM2U) +* [@kegbot](http://twitter.com/kegbot) on +Twitter ## Related Projects diff --git a/docs/rtd-requirements.txt b/docs/rtd-requirements.txt new file mode 100644 index 000000000..ca5e0a104 --- /dev/null +++ b/docs/rtd-requirements.txt @@ -0,0 +1 @@ +sphinx-issues==1.2.0