From 0dc0dd0027fb72ef6f2cf8f862623bcd727c8cd8 Mon Sep 17 00:00:00 2001 From: Orakaro Date: Fri, 11 Jul 2014 15:53:38 +0900 Subject: [PATCH] Update index.rst --- docs/index.rst | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 55c9092..9c05a85 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,21 +15,29 @@ This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_. 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 ----- @@ -225,3 +233,4 @@ For detaile information, see `theme usage and customization`_. .. _Python Twitter Tool: http://mike.verdone.ca/twitter/ .. _Twitter API: https://dev.twitter.com/docs/api/1.1 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md +.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/ -- 2.25.1