projects
/
rainbowstream.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
45e6bb0
)
Update index.rst
author
Orakaro
<nhatminh_179@hotmail.com>
Fri, 11 Jul 2014 06:53:38 +0000
(15:53 +0900)
committer
Orakaro
<nhatminh_179@hotmail.com>
Fri, 11 Jul 2014 06:53:38 +0000
(15:53 +0900)
docs/index.rst
patch
|
blob
|
blame
|
history
diff --git
a/docs/index.rst
b/docs/index.rst
index 55c9092719f69ffd4ad78bae63588850537c0431..9c05a850f6b4dfb8541eb5d8b176c0aee7ac10a8 100644
(file)
--- 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
\r
-------
\r
\r
Install
\r
-------
\r
\r
-You will need Python 2.7+ and pip.
\r
+The quick way
\r
+^^^^^^^^^^^^^
\r
+
\r
+You will need Python 2.7 and pip.
\r
\r
.. code:: bash
\r
\r
sudo pip install rainbowstream
\r
\r
\r
.. code:: bash
\r
\r
sudo pip install rainbowstream
\r
\r
-or try with a virtualenv
\r
+The recommended way
\r
+^^^^^^^^^^^^^^^^^^^
\r
+
\r
+Use `virtualenv`_
\r
\r
.. code:: bash
\r
\r
\r
.. code:: bash
\r
\r
- sudo pip install virtualenv # skip if you already have virtualenv
\r
virtualenv venv
\r
virtualenv venv
\r
- source venv/bin/activate # use the brand new virtualenv.
\r
+ # Python 3 users : use -p to specify your Python 3 localtion as below
\r
+ # virtualenv -p /usr/bin/python3 venv
\r
+ source venv/bin/activate
\r
pip install rainbowstream
\r
\r
pip install rainbowstream
\r
\r
+
\r
Usage
\r
-----
\r
\r
Usage
\r
-----
\r
\r
@@
-225,3
+233,4
@@
For detaile information, see `theme usage and customization`_.
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/
\r
.. _Twitter API: https://dev.twitter.com/docs/api/1.1
\r
.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
\r
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/
\r
.. _Twitter API: https://dev.twitter.com/docs/api/1.1
\r
.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
\r
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
\r