X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=a621318ecbe9084a8447985da3a50e82800cdc22;hp=646f7c4a8afbfd9a5c224d48ae26cc756c80adde;hb=422dd3858dacc83de5e9d053140341b62a44012b;hpb=791035e03b11b79a83381b7213bbe19ff46ca3cf diff --git a/README.md b/README.md index 646f7c4..a621318 100644 --- a/README.md +++ b/README.md @@ -17,23 +17,26 @@ Screenshot: (Click to see) ![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png) ## Install -You will need Python 2.7+ and pip. - +#### The quick way +You will need Python and pip (2.7.x or 3.x). ```bash sudo pip install rainbowstream +# Python 3 users: sudo pip3 install rainbowstream ``` -or try with a virtualenv +#### The recommended way +Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) ```bash -sudo pip install virtualenv # skip if you already have virtualenv virtualenv venv -source venv/bin/activate # use the brand new virtualenv. +# Python 3 users : use -p to specify your Python 3 localtion as below +# virtualenv -p /usr/bin/python3 venv +source venv/bin/activate pip install rainbowstream ``` ## Usage -#### The stream + Just type ```bash rainbowstream @@ -56,7 +59,9 @@ Simply type "h" and hit the Enter key to see the help. Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well. -Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) . +## Available commands + +Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) . ## Theme customization Rainbow Stream is shipped with some default themes. @@ -84,7 +89,7 @@ If you want to build a runnable version yourself, follow these simple steps * [Create your own Twitter Application](https://apps.twitter.com/app/new) * Get your Twitter application's API key and secret * Fork this repo -* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with folowwing content. +* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content ```python # Consumer information CONSUMER_KEY = 'APIKey' # Your Twitter application's API key @@ -93,9 +98,11 @@ CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret * Use pip to install in local ```bash # cd to directory which contains setup.py +virtualenv venv # Python3 users: use -p to specify python3 +source venv/bin/activate pip install -e . -pip list # confirm installed version -rainbowstream # Local version of rainbowstream +pip list | grep rainbowstream # confirm installed version +rainbowstream # local version of rainbowstream ``` ## Contributing