From 9d61c4c549af87374b2e3fcb837dc422e2a15b63 Mon Sep 17 00:00:00 2001 From: nyuszika7h Date: Wed, 4 Sep 2013 12:16:37 +0200 Subject: [PATCH 1/2] Rename README to README.rst --- README | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index af4feb5..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 From 87033ad3ca5714f7e7626ce37648b2057e26d960 Mon Sep 17 00:00:00 2001 From: nyuszika7h Date: Wed, 4 Sep 2013 12:32:13 +0200 Subject: [PATCH 2/2] Convert README.rst to rST and clarify instructions --- README.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.rst 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