Updated README faq, added requirements.txt.

This commit is contained in:
Michael Lazar
2015-10-20 01:24:58 -07:00
parent 9842e187b8
commit e950f99e81
3 changed files with 37 additions and 14 deletions

View File

@@ -2,7 +2,8 @@
RTV: Reddit Terminal Viewer RTV: Reddit Terminal Viewer
=========================== ===========================
RTV is an application that allows you to view and interact with reddit from your terminal. It is compatible with *most* terminal emulators on Linux and OSX. RTV is an application that allows you to view and interact with reddit from your terminal.
It is compatible with *most* terminal emulators on Linux and OSX.
.. image:: http://i.imgur.com/xpOEi1E.png .. image:: http://i.imgur.com/xpOEi1E.png
@@ -17,6 +18,7 @@ RTV is built in **python** using the **curses** library.
* `Installation`_ * `Installation`_
* `Usage`_ * `Usage`_
* `Configuration`_ * `Configuration`_
* `FAQ`_
* `Changelog`_ * `Changelog`_
* `Contributors`_ * `Contributors`_
* `License`_ * `License`_
@@ -33,18 +35,11 @@ Install using pip
Or clone the repository Or clone the repository
Note for pip users, your default python version may not be python3.
Which may cause some errors when trying to run rtv.
Debian/Ubuntu/Mint users can do ``sudo apt-get install python3-pip``,
then replace pip with pip3 in the command above to use pip with python3 to install rtv.
.. code-block:: bash .. code-block:: bash
$ git clone https://github.com/michael-lazar/rtv.git $ git clone https://github.com/michael-lazar/rtv.git
$ cd rtv $ cd rtv
$ sudo python setup.py install $ sudo python3 setup.py install
The installation will place a script in the system path The installation will place a script in the system path
@@ -53,6 +48,8 @@ The installation will place a script in the system path
$ rtv $ rtv
$ rtv --help $ rtv --help
See the `FAQ`_ for more information on common installation problems
===== =====
Usage Usage
===== =====
@@ -204,16 +201,31 @@ Example initial config:
FAQ FAQ
=== ===
How do I run the code directly using python? Why am I getting an error during installation/when launching rtv?
This project is structured to be run as a python *module*. This means that in order to resolve imports you need to launch using python's ``-m`` flag. This method works for all versions of python. Follow the example below, which assumes that you have cloned the repository into the directory **~/rtv_project**. If your distro ships with an older version of python 2.7 or python-requests,
you may experience SSL errors or other package incompatibilities. The
easiest way to fix this is to install rtv using python 3. If you
don't already have pip3, see http://stackoverflow.com/a/6587528 for setup
instructions. Then do
.. code-block:: bash
$ sudo pip uninstall rtv
$ sudo pip3 install -U rtv
How do I run the repository code directly?
This project is structured to be run as a python *module*. This means that in
order to resolve imports you need to launch using python's ``-m`` flag.
This method works for all versions of python. See the example below, which
assumes that you have cloned the repository into the directory
**~/rtv_project**.
.. code-block:: bash .. code-block:: bash
$ cd ~/rtv_project $ cd ~/rtv_project
$ python2 -m rtv $ python3 -m pip install -r requirements.py3.txt
$ python3 -m rtv $ python3 -m rtv
========= =========
Changelog Changelog
========= =========

6
requirements.py2.txt Normal file
View File

@@ -0,0 +1,6 @@
tornado
praw>=3.3.0
six
requests
kitchen
futures

5
requirements.py3.txt Normal file
View File

@@ -0,0 +1,5 @@
tornado
praw>=3.3.0
six
requests
kitchen