From dd8539f581bd3541b9476ac3a62ad6627426e098 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 11 Feb 2016 18:20:35 -0800 Subject: [PATCH 01/17] Simplified a bunch of the language in the readme. --- CONTROLS.rst | 65 ++++++++++++++++++++++++ README.rst | 135 +++++++++++--------------------------------------- rtv/config.py | 2 +- rtv/docs.py | 9 +--- 4 files changed, 98 insertions(+), 113 deletions(-) create mode 100644 CONTROLS.rst diff --git a/CONTROLS.rst b/CONTROLS.rst new file mode 100644 index 0000000..8ffcea8 --- /dev/null +++ b/CONTROLS.rst @@ -0,0 +1,65 @@ +======== +Controls +======== + +-------------- +Basic Commands +-------------- + +:``j``/``k`` or ``▲``/``▼``: Move the cursor up/down +:``m``/``n`` or ``PgUp``/``PgDn``: Jump to the previous/next page +:``1-5``: Toggle post order (*hot*, *top*, *rising*, *new*, *controversial*) +:``r`` or ``F5``: Refresh page content +:``u``: Log in or switch accounts +:``?``: Show the help screen +:``q``/``Q``: Quit/Force quit + +---------------------- +Authenticated Commands +---------------------- + +Some actions require that you be logged in to your reddit account. +You can log in by pressing ``u`` while inside of the program. +Once you are logged in your username will appear in the top-right corner of the screen. + +:``a``/``z``: Upvote/downvote +:``c``: Compose a new post or comment +:``e``: Edit an existing post or comment +:``d``: Delete an existing post or comment +:``i``: Display new messages prompt +:``s``: View a list of subscribed subreddits + +-------------- +Subreddit Mode +-------------- + +In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. + +:``l`` or ``►``: Enter the selected submission +:``o`` or ``ENTER``: Open the submission link with your web browser +:``/``: Open a prompt to switch subreddits +:``f``: Open a prompt to search the current subreddit + +The ``/`` prompt accepts subreddits in the following formats + +* ``/r/python`` +* ``/r/python/new`` +* ``/r/python+linux`` supports multireddits +* ``/r/front`` will redirect to the front page +* ``/r/me`` will display your submissions + +--------------- +Submission Mode +--------------- + +In submission mode you can view the self text for a submission and browse comments. + +:``h`` or ``◄``: Return to the subreddit +:``o`` or ``ENTER``: Open the comment permalink with your web browser +:``SPACE``: Fold the selected comment, or load additional comments + +------- +Key Map +------- + +.. image:: http://i.imgur.com/xDUQ03C.png \ No newline at end of file diff --git a/README.rst b/README.rst index 2d668ee..0c744f6 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ 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 allows you to view and interact with reddit from your terminal. +It's compatible with *most* terminal emulators on Linux and OSX. .. image:: http://i.imgur.com/Ek13lqM.png @@ -22,7 +22,6 @@ RTV is built in **python** using the **curses** library. * `Configuration`_ * `FAQ`_ * `Changelog`_ -* `Contributors`_ * `License`_ ============ @@ -33,98 +32,34 @@ Install using pip .. code-block:: bash - $ sudo pip install rtv + $ pip install rtv -Or clone the repository +or clone the repository .. code-block:: bash $ git clone https://github.com/michael-lazar/rtv.git $ cd rtv - $ sudo python3 setup.py install + $ python3 setup.py install -The installation will place a script in the system path +and run it .. code-block:: bash $ rtv - $ rtv --help -See the `FAQ`_ to troubleshoot common installation problems +See the `FAQ`_ for troubleshooting ===== Usage ===== -RTV supports browsing both subreddits and submission comments. - -Navigating is simple and intuitive. Move the cursor using either the arrow keys or *Vim* style movement. -Move **up** and **down** to scroll through the page. -Move **right** to view the selected submission, and **left** to exit the submission. +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. --------------- -Basic Commands --------------- - -:``j``/``k`` or ``▲``/``▼``: Move the cursor up/down -:``m``/``n`` or ``PgUp``/``PgDn``: Jump to the previous/next page -:``1-5``: Toggle post order (*hot*, *top*, *rising*, *new*, *controversial*) -:``r`` or ``F5``: Refresh page content -:``u``: Log in or switch accounts -:``?``: Show the help screen -:``q``/``Q``: Quit/Force quit - ----------------------- -Authenticated Commands ----------------------- - -Some actions require that you be logged in to your reddit account. -You can log in by pressing ``u`` while inside of the program. -Once you are logged in your username will appear in the top-right corner of the screen. - -:``a``/``z``: Upvote/downvote -:``c``: Compose a new post or comment -:``e``: Edit an existing post or comment -:``d``: Delete an existing post or comment -:``i``: Display new messages prompt -:``s``: View a list of subscribed subreddits - --------------- -Subreddit Mode --------------- - -In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. - -:``l`` or ``►``: Enter the selected submission -:``o`` or ``ENTER``: Open the submission link with your web browser -:``/``: Open a prompt to switch subreddits -:``f``: Open a prompt to search the current subreddit - -The ``/`` prompt accepts subreddits in the following formats - -* ``/r/python`` -* ``/r/python/new`` -* ``/r/python+linux`` supports multireddits -* ``/r/front`` will redirect to the front page -* ``/r/me`` will display your submissions - ---------------- -Submission Mode ---------------- - -In submission mode you can view the self text for a submission and browse comments. - -:``h`` or ``◄``: Return to the subreddit -:``o`` or ``ENTER``: Open the comment permalink with your web browser -:``SPACE``: Fold the selected comment, or load additional comments - - -======= -Key Map -======= - -.. image:: http://i.imgur.com/xDUQ03C.png +See `CONTROLS.rst `_ for the complete list of commands. ============= Configuration @@ -134,41 +69,38 @@ Configuration Editor ------ -RTV allows users to compose comments and replies using their preferred text editor (**vi**, **nano**, **gedit**, etc). -You can specify which text editor you would like to use by setting the ``$RTV_EDITOR`` environment variable. +You can compose posts and reply to comments using your preferred text editor. +Specify the editor by setting ``$RTV_EDITOR`` in your environment. .. code-block:: bash $ export RTV_EDITOR=gedit -If no editor is specified, RTV will fallback to the system's default ``$EDITOR``, and finally to ``nano``. +If not specified, the default system ``$EDITOR`` (or *nano*) will be used. ----------- Web Browser ----------- -RTV has the capability to open links inside of your web browser. -By default RTV will use the system's browser. -On most systems this corresponds to a graphical browser such as Firefox or Chrome. -If you prefer to stay in the terminal, use ``$BROWSER`` to specify a console-based web browser. +You can open submission links using your web browser. +On most systems the default web browser will open in a new window. +If you would prefer the complete terminal experience, set ``$BROWSER`` to a console-based web browser. `w3m `_, `lynx `_, and `elinks `_ are all good choices. -.. code-block:: bash - - $ export BROWSER=w3m - -------------- Authentication -------------- -RTV uses OAuth to facilitate logging into your reddit user account [#]_. The login process follows these steps: +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. -1. You initiate a login by pressing the ``u`` key. -2. You're redirected to a webbrowser where reddit will ask you to login and authorize RTV. -3. RTV uses the generated token to login on your behalf. -4. The token is stored on your computer at ``{HOME}/.config/rtv/refresh-token`` for future sessions. You can disable this behavior by setting ``persistent=False`` in your RTV config. +RTV will retrieve your new auth token and store it locally in ``{HOME}/.config/rtv/refresh-token``. +You can disable storing the token by setting ``persistent=False`` in the config. -Note that RTV no longer allows you to input your username/password directly. This method of cookie based authentication has been deprecated by reddit and will not be supported in future releases [#]_. +Note that RTV no longer allows you to input your username/password directly. This method of cookie based authentication has been deprecated by reddit [#]_. .. [#] ``_ .. [#] ``_ @@ -177,14 +109,14 @@ Note that RTV no longer allows you to input your username/password directly. Thi Config File ----------- -RTV stores configuration settings in ``{HOME}/.config/rtv/rtv.cfg``. -You can auto-generate the config file by running +Configuration settings are stored in ``{HOME}/.config/rtv/rtv.cfg``. +Auto-generate the config file by running .. code-block:: bash $ rtv --copy-config -See the `default config `_ to view descriptions for each setting. +See the `default config `_ for a list of settings. === FAQ @@ -218,19 +150,12 @@ How do I run the repository code directly? ========= Changelog ========= -Please see `CHANGELOG.rst `_. - - -============ -Contributors -============ -Please see `CONTRIBUTORS.rst `_. - +Please see the `change log `_. ======= License ======= -Please see `LICENSE `_. +This project is distributed under the `MIT `_ license. .. |python| image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg diff --git a/rtv/config.py b/rtv/config.py index 53be7de..7519653 100644 --- a/rtv/config.py +++ b/rtv/config.py @@ -27,7 +27,7 @@ def build_parser(): parser = argparse.ArgumentParser( prog='rtv', description=docs.SUMMARY, - epilog=docs.CONTROLS+docs.HELP, + epilog=docs.CONTROLS, formatter_class=argparse.RawDescriptionHelpFormatter) parser.add_argument( '-V', '--version', action='version', version='rtv '+__version__) diff --git a/rtv/docs.py b/rtv/docs.py index eb7503f..af5bdfa 100644 --- a/rtv/docs.py +++ b/rtv/docs.py @@ -12,13 +12,8 @@ terminal window. """ CONTROLS = """ -Controls --------- -RTV currently supports browsing both subreddits and individual submissions. -In each mode the controls are slightly different. In subreddit mode you can -browse through the top submissions on either the front page or a specific -subreddit. In submission mode you can view the self text for a submission and -browse comments. +Move the cursor using either the arrow keys or *Vim* style movement. Open the +help screen by pressing the `?` key. """ HELP = """ From ee038452b9669aabf635101ce260dea15cabef2e Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 11 Feb 2016 18:27:31 -0800 Subject: [PATCH 02/17] Update README.rst --- README.rst | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 0c744f6..455e27d 100644 --- a/README.rst +++ b/README.rst @@ -34,7 +34,7 @@ Install using pip $ pip install rtv -or clone the repository +or clone the repository. .. code-block:: bash @@ -42,22 +42,20 @@ 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 `_ for the complete list of commands. From 4679b55e511de41f1c954f24f1e0441210938d71 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 11 Feb 2016 18:28:22 -0800 Subject: [PATCH 03/17] Update README.rst --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index 455e27d..3bf93af 100644 --- a/README.rst +++ b/README.rst @@ -56,6 +56,7 @@ Usage | 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 `_ for the complete list of commands. From 1968a8f969a9df9869b3f2f2fc09cdcff1462761 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 11 Feb 2016 18:29:26 -0800 Subject: [PATCH 04/17] Update README.rst --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index 3bf93af..f16db8e 100644 --- a/README.rst +++ b/README.rst @@ -92,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. From dd9879f5d101280a641735b4582fc439cb3f612a Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 11 Feb 2016 18:31:52 -0800 Subject: [PATCH 05/17] Added new line. --- rtv/docs.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rtv/docs.py b/rtv/docs.py index af5bdfa..f375c1d 100644 --- a/rtv/docs.py +++ b/rtv/docs.py @@ -12,8 +12,8 @@ terminal window. """ CONTROLS = """ -Move the cursor using either the arrow keys or *Vim* style movement. Open the -help screen by pressing the `?` key. +Move the cursor using either the arrow keys or *Vim* style movement. +Press `?` to open the help screen. """ HELP = """ From fa884bb51ce6f0b149b71186e1d6573f7a8daa36 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:05:19 -0800 Subject: [PATCH 06/17] Update CONTROLS.rst --- CONTROLS.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/CONTROLS.rst b/CONTROLS.rst index 8ffcea8..a185be0 100644 --- a/CONTROLS.rst +++ b/CONTROLS.rst @@ -2,6 +2,8 @@ Controls ======== +.. image:: http://i.imgur.com/xDUQ03C.png + -------------- Basic Commands -------------- @@ -57,9 +59,3 @@ In submission mode you can view the self text for a submission and browse commen :``h`` or ``◄``: Return to the subreddit :``o`` or ``ENTER``: Open the comment permalink with your web browser :``SPACE``: Fold the selected comment, or load additional comments - -------- -Key Map -------- - -.. image:: http://i.imgur.com/xDUQ03C.png \ No newline at end of file From e68ddc23e431b27fc16cb9d389e18fd058d28d46 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:10:19 -0800 Subject: [PATCH 07/17] Update README.rst --- README.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index f16db8e..97c37cf 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,7 @@ RTV: Reddit Terminal Viewer =========================== RTV allows you to view and interact with reddit from your terminal. + It's compatible with *most* terminal emulators on Linux and OSX. .. image:: http://i.imgur.com/Ek13lqM.png @@ -52,11 +53,13 @@ Usage $ 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. -| +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 `_ for the complete list of commands. From fdd2dd5c708b3ac4b4cc67819b04fe9a697735cd Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:11:08 -0800 Subject: [PATCH 08/17] Update README.rst --- README.rst | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 97c37cf..b54701e 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,8 @@ RTV: Reddit Terminal Viewer =========================== -RTV allows you to view and interact with reddit from your terminal. - -It's compatible with *most* terminal emulators on Linux and OSX. +| RTV allows you to view and interact with reddit from your terminal. +| It's compatible with *most* terminal emulators on Linux and OSX. .. image:: http://i.imgur.com/Ek13lqM.png @@ -53,13 +52,10 @@ Usage $ 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. +| 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 `_ for the complete list of commands. From 1e5211109bd1ef35260500847ecdd87677e0cf4e Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:11:52 -0800 Subject: [PATCH 09/17] Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index b54701e..42f4fe0 100644 --- a/README.rst +++ b/README.rst @@ -56,8 +56,8 @@ Usage | 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 `_ for the complete list of commands. +| +| See `CONTROLS.rst `_ for the complete list of commands. ============= Configuration From e4672e09355a2792cb76e4cc98236bd043f663a3 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:23:01 -0800 Subject: [PATCH 10/17] Update README.rst --- README.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 42f4fe0..e9e5257 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,7 @@ Usage | Press **right** to view the selected submission and **left** to return. | Press **?** to open the help screen. | -| See `CONTROLS.rst `_ for the complete list of commands. +| See `CONTROLS.rst `_ for the complete list of available commands. ============= Configuration @@ -68,7 +68,7 @@ Editor ------ You can compose posts and reply to comments using your preferred text editor. -Specify the editor by setting ``$RTV_EDITOR`` in your environment. +Set the editor by changing ``$RTV_EDITOR`` in your environment. .. code-block:: bash @@ -82,21 +82,26 @@ Web Browser You can open submission links using your web browser. On most systems the default web browser will open in a new window. -If you would prefer the complete terminal experience, set ``$BROWSER`` to a console-based web browser. +If you prefer the complete terminal experience, set ``$BROWSER`` to a console-based web browser. + +.. code-block:: bash + + $ export BROWSER=w3m + `w3m `_, `lynx `_, and `elinks `_ are all good choices. -------------- Authentication -------------- -RTV allows you to login to your reddit account in order to do things like vote and leave comments. +RTV enables you to login to your reddit account in order to perform actions like voting 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. +3. Click **Accept**. -RTV will retrieve your new auth token and store it locally in ``{HOME}/.config/rtv/refresh-token``. +RTV will retrieve an auth token with your information and store it locally in ``{HOME}/.config/rtv/refresh-token``. You can disable storing the token by setting ``persistent=False`` in the config. Note that RTV no longer allows you to input your username/password directly. This method of cookie based authentication has been deprecated by reddit [#]_. @@ -143,13 +148,12 @@ How do I run the repository code directly? .. code-block:: bash $ cd ~/rtv_project - $ python3 -m pip install -r requirements.py3.txt $ python3 -m rtv ========= Changelog ========= -Please see the `change log `_. +Please see `CHANGELOG.rst `_. ======= License From fe85a5993614ef5686ab5c9620a612379fce904c Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:23:46 -0800 Subject: [PATCH 11/17] Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e9e5257..a4cda1b 100644 --- a/README.rst +++ b/README.rst @@ -7,10 +7,10 @@ RTV: Reddit Terminal Viewer .. image:: http://i.imgur.com/Ek13lqM.png -RTV is built in **python** using the **curses** library. - `Demo `_ +RTV is built in **python** using the **curses** library. + --------------- |pypi| |python| |travis-ci| |coveralls| |gitter| From c643fb1b2521a89140ce5162ed11d17b2663445e Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:33:43 -0800 Subject: [PATCH 12/17] Update README.rst --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a4cda1b..2ed4b86 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ RTV is built in **python** using the **curses** library. Installation ============ -Install using pip +Install using pip... .. code-block:: bash @@ -48,6 +48,8 @@ See the `FAQ`_ for troubleshooting. Usage ===== +To run the program, type + .. code-block:: bash $ rtv --help From b71d6bd4db6cb1705d0b430f96095ab4ff358acf Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:37:53 -0800 Subject: [PATCH 13/17] Update README.rst --- README.rst | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index 2ed4b86..970409a 100644 --- a/README.rst +++ b/README.rst @@ -54,6 +54,10 @@ To run the program, type $ rtv --help +-------- +Controls +-------- + | 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. @@ -61,6 +65,25 @@ To run the program, type | | See `CONTROLS.rst `_ for the complete list of available commands. +-------------- +Authentication +-------------- + +RTV enables you to login to your reddit account in order to perform actions like voting 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**. + +RTV will retrieve an auth token with your information and store it locally in ``{HOME}/.config/rtv/refresh-token``. +You can disable storing the token by setting ``persistent=False`` in the config. + +Note that RTV no longer allows you to input your username/password directly. This method of cookie based authentication has been deprecated by reddit [#]_. + +.. [#] ``_ +.. [#] ``_ + ============= Configuration ============= @@ -92,25 +115,6 @@ If you prefer the complete terminal experience, set ``$BROWSER`` to a console-ba `w3m `_, `lynx `_, and `elinks `_ are all good choices. --------------- -Authentication --------------- - -RTV enables you to login to your reddit account in order to perform actions like voting 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**. - -RTV will retrieve an auth token with your information and store it locally in ``{HOME}/.config/rtv/refresh-token``. -You can disable storing the token by setting ``persistent=False`` in the config. - -Note that RTV no longer allows you to input your username/password directly. This method of cookie based authentication has been deprecated by reddit [#]_. - -.. [#] ``_ -.. [#] ``_ - ----------- Config File ----------- @@ -122,7 +126,7 @@ Auto-generate the config file by running $ rtv --copy-config -See the `default config `_ for a list of settings. +See the `default config `_ for the full list of settings. === FAQ From 5b28917d2dc98155e203fb8e70839ccce77dd241 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:39:32 -0800 Subject: [PATCH 14/17] Update README.rst --- README.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 970409a..e3f7f8e 100644 --- a/README.rst +++ b/README.rst @@ -58,12 +58,13 @@ To run the program, type Controls -------- -| 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 `_ for the complete list of available commands. +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 `_ for the complete list of available commands. -------------- Authentication From 5db41468b214aed959142036d98154f2843f9113 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:41:49 -0800 Subject: [PATCH 15/17] Update README.rst --- README.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.rst b/README.rst index e3f7f8e..aca0644 100644 --- a/README.rst +++ b/README.rst @@ -42,8 +42,6 @@ or clone the repository. $ cd rtv $ python3 setup.py install -See the `FAQ`_ for troubleshooting. - ===== Usage ===== From 255c3fb88cecfa85e3d82515a969448df111f04d Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:43:45 -0800 Subject: [PATCH 16/17] Update README.rst --- README.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index aca0644..b4cc970 100644 --- a/README.rst +++ b/README.rst @@ -19,7 +19,7 @@ RTV is built in **python** using the **curses** library. * `Installation`_ * `Usage`_ -* `Configuration`_ +* `Settings`_ * `FAQ`_ * `Changelog`_ * `License`_ @@ -83,9 +83,22 @@ Note that RTV no longer allows you to input your username/password directly. Thi .. [#] ``_ .. [#] ``_ -============= +======== +Settings +======== + +------------- Configuration -============= +------------- + +Configuration settings are stored in ``{HOME}/.config/rtv/rtv.cfg``. +Auto-generate the config file by running + +.. code-block:: bash + + $ rtv --copy-config + +See the `default config `_ for the full list of settings. ------ Editor @@ -114,19 +127,6 @@ If you prefer the complete terminal experience, set ``$BROWSER`` to a console-ba `w3m `_, `lynx `_, and `elinks `_ are all good choices. ------------ -Config File ------------ - -Configuration settings are stored in ``{HOME}/.config/rtv/rtv.cfg``. -Auto-generate the config file by running - -.. code-block:: bash - - $ rtv --copy-config - -See the `default config `_ for the full list of settings. - === FAQ === From 4e30aee2347b89919b7e23816292209d4d75cb8d Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Sun, 14 Feb 2016 18:45:45 -0800 Subject: [PATCH 17/17] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b4cc970..21e0387 100644 --- a/README.rst +++ b/README.rst @@ -7,7 +7,7 @@ RTV: Reddit Terminal Viewer .. image:: http://i.imgur.com/Ek13lqM.png -`Demo `_ +`DEMO `_ RTV is built in **python** using the **curses** library.