gryf/tuir
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Readme tweaks

Browse Source
This commit is contained in:
michael-lazar
2015-03-06 22:20:05 -08:00
parent 27e90b1ca1
commit d4db2a9689
1 changed files with 28 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.rst
View File

@@ -1,27 +1,28 @@
.. image:: https://pypip.in/version/rtv/badge.svg?text=version&style=flat
:target: https://pypi.python.org/pypi/rtv/
:alt: Latest Version
====================== ======================
Reddit Terminal Viewer Reddit Terminal Viewer
====================== ======================
.. image:: https://pypip.in/version/rtv/badge.svg?text=version Browse Reddit from your terminal.
:target: https://pypi.python.org/pypi/rtv/
:alt: Latest Version
**Reddit Terminal Viewer (RTV)** is a lightweight browser for Reddit (www.reddit.com) built into a terminal window.
RTV is built in Python and utilizes the **curses** library.
It is compatible with a large range of terminal emulators on Linux and OSX systems.
.. image:: http://i.imgur.com/4a3Yrov.gif .. image:: http://i.imgur.com/4a3Yrov.gif
RTV is built in python using the curses library, and is compatable with *most* terminal emulators on Linux and OS X.
------------ ------------
Installation Installation
------------ ------------
The recommended installation method is pip.
Install using pip
.. code-block:: bash .. code-block:: bash
$ sudo pip install --pre rtv $ sudo pip install --pre rtv
Alternatively, clone the repo and install with python. Or clone the repository
.. code-block:: bash .. code-block:: bash
@@ -29,7 +30,7 @@ Alternatively, clone the repo and install with python.
$ cd rtv $ cd rtv
$ sudo python setup.py install $ sudo python setup.py install
As part of the installation, an executable script will be placed in your system path. The installation will place a script in the system path
.. code-block:: bash .. code-block:: bash
@@ -44,35 +45,42 @@ RTV currently supports browsing both subreddits and individual submissions. In e
**Global Commands** **Global Commands**
:``Arrow Keys`` or ``hjkl``: RTV supports both the arrow keys and vim bindings for navigation. Move up and down to scroll through items on the page. :``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item
:``r`` or ``F5``: Refresh the current page. :``o``: Open the selected item in the default web browser
:``q``: Quit the program. :``r`` or ``F5``: Refresh the current page
:``o``: Open the url of the selected item in the default web browser. :``q``: Quit
**Subreddit Mode** **Subreddit Mode**
In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit.
:``Right`` or ``Enter``: Open the currently selected submission in a new page. :``►`` or ``l``: View comments for the selected submission
:``/``: Open a prompt to switch to a different subreddit. For example, pressing ``/`` and typing *python* will open */r/python*. You can return to Reddit's front page by using the alias */r/front*. :``/``: Open a prompt to switch subreddits
The ``/`` prompt accepts subreddits in the following formats
* ``/r/python``
* ``/r/python/new``
* ``/r/front`` will redirect to the front page
**Submission Mode** **Submission Mode**
In submission mode you can view the self text for a submission and browse comments. In submission mode you can view the self text for a submission and browse comments.
:``Right`` or ``Enter``: Toggle the currently selected comment between hidden and visible. Alternatively, load additional comments identified by *[+] more comments*. :``◄`` or ``h``: Return to subreddit mode
:``Left``: Exit the submission page and return to the subreddit. :``►`` or ``l``: Fold the selected comment, or load additional comments
------------- -------------
Configuration Configuration
------------- -------------
RTV will read a configuration dotfile located at **~/.rtv**. RTV will read a configuration file located at **~/.rtv**.
This can be used to avoid having to re-enter login credentials every time the program is launched. This can be used to avoid having to re-enter login credentials every time the program is launched.
Each line in the file will replace the corresponding default argument in the launch script. Each line in the file will replace the corresponding default argument in the launch script.
Example config file (**~/.rtv**): Example config:
**~/.rtv**
:: ::
[rtv] [rtv]