Download:
child 13:d4079b5ce7a0
parent 11:1be0d90ed46b
12:49aec9763d9e
Anton Shestakov <av6@dwimlabs.net>, Sat, 14 May 2016 18:03:07 +0800
docs: describe basic functionality, prerequisites and config

1 файлов изменено, 33 вставок(+), 0 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst Sat May 14 18:03:07 2016 +0800
@@ -0,0 +1,33 @@
+Rollbot
+=======
+
+An XMPP bot that rolls dice and other similar things.
+
+So far it has been tested (and works) on Python 2.7 and Python 3.5.
+
+
+Dependencies
+------------
+
+SleekXMPP for the XMPP part, PyYAML for the config parsing part.
+
+
+Configuration
+-------------
+
+Example file to use with ``--config``:
+
+.. code:: yaml
+
+ jid: rollbot@example.com
+ password: hunter2
+ nick: rollbot
+ prefix: '!'
+
+These options can be overridden on command line, like ``--nick smartbot``.
+
+
+License
+-------
+
+WTFPL