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

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

Browse Source
This commit is contained in:
Michael Lazar
2016-02-11 18:32:32 -08:00
parent dd9879f5d1 1968a8f969
commit 4a10c4a318
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.rst
View File

@@ -34,7 +34,7 @@ Install using pip
$ pip install rtv $ pip install rtv
or clone the repository or clone the repository.
.. code-block:: bash .. code-block:: bash
@@ -42,22 +42,21 @@ or clone the repository
$ cd rtv $ cd rtv
$ python3 setup.py install $ python3 setup.py install
and run it See the `FAQ`_ for troubleshooting.
.. code-block:: bash
$ rtv
See the `FAQ`_ for troubleshooting
===== =====
Usage Usage
===== =====
Move the cursor using either the arrow keys or *Vim* style movement. .. code-block:: bash
Press **up** and **down** to scroll through submissions.
Press **right** to view the selected submission and **left** to return. $ rtv --help
Press **?** to open the help screen.
| 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. 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. 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: The login process uses OAuth [#]_ and follows these steps:
1. Initiate a login by pressing the ``u`` key. 1. Initiate a login by pressing the ``u`` key.
2. Open a new webpage where reddit will ask you to authorize the application. 2. Open a new webpage where reddit will ask you to authorize the application.
3. Click accept. 3. Click accept.