Update README
This commit is contained in:
parent
663e5e7207
commit
26668c81b1
41
README.md
41
README.md
@ -1,9 +1,11 @@
|
||||
# *nemubot*
|
||||
nemubot
|
||||
=======
|
||||
|
||||
An extremely modulable IRC bot, built around XML configuration files!
|
||||
|
||||
|
||||
## Requirements
|
||||
Requirements
|
||||
------------
|
||||
|
||||
*nemubot* requires at least Python 3.3 to work.
|
||||
|
||||
@ -12,6 +14,37 @@ Some modules (like `cve`, `nextstop` or `laposte`) require the
|
||||
but the core and framework has no dependency.
|
||||
|
||||
|
||||
## Documentation
|
||||
Installation
|
||||
------------
|
||||
|
||||
Have a look to the wiki at https://github.com/nemunaire/nemubot/wiki
|
||||
Use the `setup.py` file: `python setup.py install`.
|
||||
|
||||
### VirtualEnv setup
|
||||
|
||||
The easiest way to do this is through a virtualenv:
|
||||
|
||||
```sh
|
||||
virtualenv venv
|
||||
. venv/bin/activate
|
||||
python setup.py install
|
||||
```
|
||||
|
||||
### Create a new configuration file
|
||||
|
||||
There is a sample configuration file, called `bot_sample.xml`. You can
|
||||
create your own configuration file from it.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Don't forget to activate your virtualenv in further terminals, if you
|
||||
use it.
|
||||
|
||||
To launch the bot, run:
|
||||
|
||||
```sh
|
||||
nemubot bot.xml
|
||||
```
|
||||
|
||||
Where `bot.xml` is your configuration file.
|
||||
|
Loading…
Reference in New Issue
Block a user