diff --git a/README b/README deleted file mode 100644 index 9ae2d33..0000000 --- a/README +++ /dev/null @@ -1,4 +0,0 @@ -Use Python 3.2 (3.1 doesn't work) -configure botconfig.py by following the example in botconfig.py.example -if desired, configure settings/wolfgame.py to modify game settings -run wolfbot.py diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..7ddfdf3 --- /dev/null +++ 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