Convert README.rst to rST and clarify instructions

2013-09-04 12:32:13 +02:00 · 2013-09-04 12:32:13 +02:00 · 87033ad3ca
commit 87033ad3ca
parent 9d61c4c549
1 changed files with 29 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@ -0,0 +1,29 @@
+======
+README
+======
+
+------------
+Dependencies
+------------
+
+- Python 3.2+ (3.1 doesn't work)
+
+-------------
+Configuration
+-------------
+
+Copy ``botconfig.py.example`` to ``botconfig.py`` and modify the
+settings as needed. If desired, edit ``settings/modify.py`` to modify
+game settings.
+
+----------------
+Starting the bot
+----------------
+
+To start the bot, you can simply execute ``wolfbot.py``::
+
+    $ ./wolfbot.py
+
+Debug mode can be enabled with the ``--debug`` argument::
+
+    $ ./wolfbot.py --debug