Update README.rst

This commit is contained in:
Théo Piboubès
2015-08-10 01:20:20 +02:00
parent ffd4d4f2a5
commit 7e6f639162

View File

@@ -28,7 +28,7 @@ Installation
Install using pip Install using pip
.. code-block:: bash .. code-block:: bash
$ sudo pip install rtv $ sudo pip install rtv
Or clone the repository Or clone the repository
@@ -47,12 +47,12 @@ The installation will place a script in the system path
$ rtv --help $ rtv --help
===== =====
Usage Usage
===== =====
RTV supports browsing both subreddits and submission comments. RTV supports browsing both subreddits and submission comments.
Navigating is simple and intuitive. Navigating is simple and intuitive.
Move the cursor using either the arrow keys or *Vim* style movement. Move the cursor using either the arrow keys or *Vim* style movement.
Move **up** and **down** to scroll through the page. Move **up** and **down** to scroll through the page.
Move **right** to view the selected submission, and **left** to exit the submission. Move **right** to view the selected submission, and **left** to exit the submission.
@@ -84,6 +84,7 @@ Once you are logged in your username will appear in the top-right corner of the
:``c``: Compose a new post or comment :``c``: Compose a new post or comment
:``e``: Edit an existing post or comment :``e``: Edit an existing post or comment
:``d``: Delete an existing post or comment :``d``: Delete an existing post or comment
:``s``: Open subscribed subreddits list
-------------- --------------
Subreddit Mode Subreddit Mode
@@ -96,7 +97,7 @@ In subreddit mode you can browse through the top submissions on either the front
:``f``: Open a prompt to search the current subreddit :``f``: Open a prompt to search the current subreddit
The ``/`` prompt accepts subreddits in the following formats The ``/`` prompt accepts subreddits in the following formats
* ``/r/python`` * ``/r/python``
* ``/r/python/new`` * ``/r/python/new``
* ``/r/python+linux`` supports multireddits * ``/r/python+linux`` supports multireddits
@@ -126,7 +127,7 @@ You can specify which text editor you would like to use by setting the ``$RTV_ED
.. code-block:: bash .. code-block:: bash
$ export RTV_EDITOR=gedit $ export RTV_EDITOR=gedit
If no editor is specified, RTV will fallback to the system's default ``$EDITOR``, and finally to ``nano``. If no editor is specified, RTV will fallback to the system's default ``$EDITOR``, and finally to ``nano``.
----------- -----------