Update the docs

This commit is contained in:
Joscha 2019-04-14 16:10:40 +00:00
parent 86472afb3f
commit 7780cb92de
3 changed files with 38 additions and 1 deletions

13
docs/bot_setup.md Normal file
View file

@ -0,0 +1,13 @@
# Setting up and running a bot
## Installing yaboli
TODO
## Configuring the bot
TODO
## Running the bot
TODO

View file

@ -1,6 +1,17 @@
# Index for yaboli docs
Links to specific sections will be added here.
- [Setting up and running a bot](bot_setup.md)
- Classes
- [Bot](bot.md)
## Getting started
First, read the [overview](#library-structure-overview) below.
To set up your project, follow the [setup guide](bot_setup.md).
To get a feel for how bots are structured, have a look at the example bots or
read through the docstrings in the `Bot` class.
## Library structure overview

View file

@ -0,0 +1,13 @@
# python stuff
__pycache__/
# venv stuff
bin/
include/
lib/
lib64
pyvenv.cfg
# config files
*.conf
cookie_jar