Garmelon/yaboli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up readme

Browse source
This commit is contained in:
Joscha 2019-04-13 15:36:02 +00:00
parent e09e2d215f
commit 0d58f61652
1 changed files with 5 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -3,24 +3,19 @@
Yaboli (**Y**et **A**nother **Bo**t **Li**brary) is a Python library for Yaboli (**Y**et **A**nother **Bo**t **Li**brary) is a Python library for
creating bots for [euphoria.io](https://euphoria.io). creating bots for [euphoria.io](https://euphoria.io).
- [Changelog](CHANGELOG.md)
- [Documentation](docs/index.md) - [Documentation](docs/index.md)
- [Changelog](CHANGELOG.md)
Soon, markdown files containing troubleshooting info will be available.
## Installation ## Installation
Ensure that you have at least Python 3.7 installed. The commands below assume Ensure that you have at least Python 3.7 installed.
that `python` points this version of Python.
In your project directory, run:
``` ```
$ python -m venv .
$ . bin/activate
$ pip install git+https://github.com/Garmelon/yaboli@v0.2.0 $ pip install git+https://github.com/Garmelon/yaboli@v0.2.0
``` ```
The use of [venv](https://docs.python.org/3/library/venv.html) is recommended.
## Example echo bot ## Example echo bot
A simple echo bot that conforms to the A simple echo bot that conforms to the
@ -43,7 +38,7 @@ class EchoBot(yaboli.Bot):
await message.reply(args.raw) await message.reply(args.raw)
``` ```
The bot's nick and default rooms are specified in a config file. The bot's nick, cookie file and default rooms are specified in a config file.
The help command from the botrulez uses the `HELP_GENERAL` and `HELP_SPECIFIC` The help command from the botrulez uses the `HELP_GENERAL` and `HELP_SPECIFIC`
fields. fields.