X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7df81d8e91050f2e6bb293fa1d99dc6dbdd12d62;hp=d97214f6417f328895a2bd746416f0a82dd4235e;hb=45e6bb0df0f868a841c41e51e905a679f5ce2015;hpb=090327d8c0d1233738bb0a9c5c47bf1b49f2ee54 diff --git a/README.rst b/README.rst index d97214f..7df81d8 100644 --- a/README.rst +++ b/README.rst @@ -20,21 +20,30 @@ Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s Install ------- -You will need Python 2.7+ and pip. +The quick way +^^^^^^^^^^^^^ + +You will need Python 2.7 and pip. .. code:: bash sudo pip install rainbowstream -or try with a virtualenv + +The recommended way +^^^^^^^^^^^^^^^^^^^ + +Use `virtualenv`_ .. code:: 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 ----- @@ -131,3 +140,4 @@ details .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/ .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md +.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/