Found a bug or a feature request ?\r
Please `create an issue`_ or contact me at `@dtvd88`_\r
\r
+Development\r
+-----------\r
+\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
+\r
+- `Create your own Twitter Application`_\r
+- Get your Twitter application’s API key and secret\r
+- Fork github's repo\r
+- Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
+ following content\r
+\r
+ .. code:: python\r
+\r
+ # Consumer information\r
+ CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
+ CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
+\r
+- Use pip to install in local\r
+\r
+ .. code:: bash\r
+\r
+ # cd to directory which contains setup.py\r
+ virtualenv venv # Python3 users: use -p to specify python3\r
+ source venv/bin/activate\r
+ pip install -e .\r
+ pip list | grep rainbowstream # confirm installed version\r
+ rainbowstream # local version of rainbowstream\r
+\r
+\r
Contributing\r
------------\r
I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
+.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r