Merge branch 'streamlining_readme' of https://github.com/michael-lazar/rtv into streamlining_readme

This commit is contained in:
Michael Lazar
2016-02-11 18:32:32 -08:00

View File

@@ -34,7 +34,7 @@ Install using pip
$ pip install rtv
or clone the repository
or clone the repository.
.. code-block:: bash
@@ -42,22 +42,21 @@ or clone the repository
$ cd rtv
$ python3 setup.py install
and run it
.. code-block:: bash
$ rtv
See the `FAQ`_ for troubleshooting
See the `FAQ`_ for troubleshooting.
=====
Usage
=====
Move the cursor using either the arrow keys or *Vim* style movement.
Press **up** and **down** to scroll through submissions.
Press **right** to view the selected submission and **left** to return.
Press **?** to open the help screen.
.. code-block:: bash
$ rtv --help
| Move the cursor using either the arrow keys or *Vim* style movement.
| Press **up** and **down** to scroll through submissions.
| Press **right** to view the selected submission and **left** to return.
| Press **?** to open the help screen.
|
See `CONTROLS.rst <https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst>`_ for the complete list of commands.
@@ -93,6 +92,7 @@ Authentication
RTV allows you to login to your reddit account in order to do things like vote and leave comments.
The login process uses OAuth [#]_ and follows these steps:
1. Initiate a login by pressing the ``u`` key.
2. Open a new webpage where reddit will ask you to authorize the application.
3. Click accept.