From b8659bb5e6fb14d1aac2cc22e3410b9fc3a71512 Mon Sep 17 00:00:00 2001 From: levi-rs Date: Mon, 5 Dec 2016 22:41:47 -0600 Subject: [PATCH] Fix README formatting --- README.rst | 45 ++++++++++++++++++++++++++++++--------------- 1 file changed, 30 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 5b9295c..2f0836c 100644 --- a/README.rst +++ b/README.rst @@ -12,26 +12,32 @@ Dankbot .. |CodeHealth| image:: https://landscape.io/github/DankCity/dankbot/master/landscape.svg?style=flat :target: https://landscape.io/github/DankCity/dankbot/master :alt: Code Health -.. |StoriesInReady| https://badge.waffle.io/DankCity/dankbot.svg?label=ready&title=Ready - :target: http://waffle.io/DankCity/dankbot +.. |StoriesInReady| image:: https://badge.waffle.io/DankCity/dankbot.svg?label=ready&title=Ready + :target: http://waffle.io/DankCity/dankbot A Slack Bot that scrapes memes from subreddits and posts them to slack -## Steps to run +Steps to run +============ + +Clone into directory +-------------------- +:: -### Clone into directory -.. code-block:: shell cd /opt sudo mkdir dankbot && sudo chown : dankbot git clone git@github.com:DankCity/dankbot.git -### Setup INI file -.. code-block:: shell +Setup INI file +-------------- +:: + cd /opt/dankbot cp dankbot/dankbot.ini.sample dankbot/dankbot.ini Edit the INI file to fill in the missing token, username, and password fields: :: + (.venv35)➜ dankbot git:(master) ✗ cat dankbot/dankbot.ini.sample [slack] token: @@ -53,30 +59,39 @@ Edit the INI file to fill in the missing token, username, and password fields: include_nsfw: max_memes: 3 -### Create and activate a virtual environment -.. code-block:: shell +Create and activate a virtual environment +----------------------------------------- +:: + cd /opt/dankbot virtualenv --python=`which python3` env source env/bin/activate -### Install the python package -.. code-block:: shell +Install the python package +-------------------------- +:: + cd /opt/dankbot source env/bin/activate pip install -e . -### Create logging folder -.. code-block:: shell +Create logging folder +--------------------- +:: + sudo mkdir /var/log/dankbot sudo chown /var/log/dankbot -### Add an entry to your crontab: +Add an entry to your crontab +----------------------------- Edit the crontab with your favorite editor -.. code-block:: shell +:: + sudo vi /etc/crontab And add an entry like so: :: + # /etc/crontab: system-wide crontab # Unlike any other crontab you don't have to run the 'crontab' # command to install the new version when you edit this file