diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ccb1bb --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +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/wolfgame.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 + +Verbose logging can be enabled with the ``--verbose`` argument + + $ ./wolfbot.py --verbose + +Playing the game +---------------- + +You can find us in ``##werewolf`` on [`freenode`](https://freenode.net). This bot is running +there and we have an active community. We'd love for you to join us! + +**Connecting to IRC** + +| Method | Link | +| ------------ | ----------------------------------------------------- | +| Webchat | https://webchat.freenode.net/?channels=%23%23werewolf | +| Client | irc://chat.freenode.net:6667/%23%23werewolf | +| Client (SSL) | ircs://chat.freenode.net:6697/%23%23werewolf | diff --git a/README.rst b/README.rst deleted file mode 100644 index 5492483..0000000 --- a/README.rst +++ /dev/null @@ -1,48 +0,0 @@ ------------- -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/wolfgame.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 - -Verbose logging can be enabled with the ``--verbose`` argument:: - - $ ./wolfbot.py --verbose - ----------------- -Playing the game ----------------- - -You can find us in ``##werewolf`` on `freenode`_. This bot is running -there and we have an active community. We'd love for you to join us! - -**Connecting to IRC** - -============ ===================================================== -Method Link -============ ===================================================== -Webchat https://webchat.freenode.net/?channels=%23%23werewolf -Client irc://chat.freenode.net:6667/%23%23werewolf -Client (SSL) ircs://chat.freenode.net:6697/%23%23werewolf -============ ===================================================== - -.. _freenode: https://freenode.net/