Skip to content

Commit

Permalink
Merge pull request #387 from Kegbot/mikey/readme
Browse files Browse the repository at this point in the history
Update README; update RTD build
  • Loading branch information
mik3y authored Feb 23, 2020
2 parents 74d5bb9 + 7b3f690 commit 8430b48
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
5 changes: 5 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
version: 2
python:
version: 3
install:
- requirements: docs/rtd-requirements.txt
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/rtd-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-issues==1.2.0

0 comments on commit 8430b48

Please sign in to comment.