X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7df81d8e91050f2e6bb293fa1d99dc6dbdd12d62;hp=ab0715ae30192d33fe2d9e3d3de3fcf9240f5f4f;hb=ff858bfb99c554b1acc422ef1706c0ae7d2152e5;hpb=98258022cd5797b59fd0ecf4b4fe3e5e1b36cea0;ds=sidebyside diff --git a/README.rst b/README.rst index ab0715a..7df81d8 100644 --- a/README.rst +++ b/README.rst @@ -16,32 +16,34 @@ Showcase ---------- Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s -Screenshot: - -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png - :alt: rainbowstream - -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png - :alt: rainbowstreamIOT 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 ----- @@ -138,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/