Skip to content

Commit

Permalink
Fix README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
levi-rs committed Dec 6, 2016
1 parent a53dfe3 commit 5360c21
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,23 @@ 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 <user>:<user> dankbot
git clone git@github.com:DankCity/dankbot.git
### Setup INI file
Setup INI file
--------------
.. code-block:: shell
cd /opt/dankbot
cp dankbot/dankbot.ini.sample dankbot/dankbot.ini
Expand Down Expand Up @@ -53,24 +56,28 @@ Edit the INI file to fill in the missing token, username, and password fields:
include_nsfw: <boolean>
max_memes: 3

### Create and activate a virtual environment
Create and activate a virtual environment
-----------------------------------------
.. code-block:: shell
cd /opt/dankbot
virtualenv --python=`which python3` env
source env/bin/activate
### Install the python package
Install the python package
--------------------------
.. code-block:: shell
cd /opt/dankbot
source env/bin/activate
pip install -e .
### Create logging folder
Create logging folder
---------------------
.. code-block:: shell
sudo mkdir /var/log/dankbot
sudo chown <user> /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
Expand Down

0 comments on commit 5360c21

Please sign in to comment.