From 013f2727230b3cb16f77646b64a692cdb414fc40 Mon Sep 17 00:00:00 2001 From: Johnathan Jenkins Date: Tue, 19 Apr 2016 13:01:32 -0700 Subject: [PATCH 1/4] [readme] add steps for archlinux installation --- README.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.rst b/README.rst index e00e824..f0cce7f 100644 --- a/README.rst +++ b/README.rst @@ -42,6 +42,21 @@ or clone the repository. $ cd rtv $ python3 setup.py install +Arch Linux or Arch based distros... + +.. code:: bash + + $ yaourt -S rtv + +This includes Arch Linux, Antergos, Manjaro, etc. `List`_ +You will need an aur helper such as yaourt shown above. If you are not fimilar with aur helper's, +you can find a list `here`_. There is also a *rtv-git* package if you wish to keep up to date with current code +before any releases are made. + +.. _List: https://wiki.archlinux.org/index.php/Arch_based_distributions_(active) +.. _here: https://wiki.archlinux.org/index.php/AUR_helpers#AUR_search.2Fbuild_helpers + + ===== Usage ===== From 5879234b9722f76bcaa2c65c2fc0309bf099adeb Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Tue, 19 Apr 2016 23:13:09 -0700 Subject: [PATCH 2/4] Update README.rst Shortened Arch Linux section --- README.rst | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index f0cce7f..6d9cd75 100644 --- a/README.rst +++ b/README.rst @@ -28,13 +28,13 @@ RTV is built in **python** using the **curses** library. Installation ============ -Install using pip... +Install using pip (**recommended**)... .. code-block:: bash $ pip install rtv -or clone the repository. +or clone the repository .. code-block:: bash @@ -42,20 +42,14 @@ or clone the repository. $ cd rtv $ python3 setup.py install -Arch Linux or Arch based distros... +on Arch Linux or Arch based distros (Antergos, Manjaro, `etc.`_) you can install directly using an `aur helper`_ such as yaourt. There's also an *rtv-git* package if you wish to keep up to date with the latest development code. .. code:: bash $ yaourt -S rtv -This includes Arch Linux, Antergos, Manjaro, etc. `List`_ -You will need an aur helper such as yaourt shown above. If you are not fimilar with aur helper's, -you can find a list `here`_. There is also a *rtv-git* package if you wish to keep up to date with current code -before any releases are made. - -.. _List: https://wiki.archlinux.org/index.php/Arch_based_distributions_(active) -.. _here: https://wiki.archlinux.org/index.php/AUR_helpers#AUR_search.2Fbuild_helpers - +.. _etc.: https://wiki.archlinux.org/index.php/Arch_based_distributions_(active) +.. _aur helper: https://wiki.archlinux.org/index.php/AUR_helpers#AUR_search.2Fbuild_helpers ===== Usage From 88c9a65bf67d8e6a5fac8799317bea48726e45cc Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Tue, 19 Apr 2016 23:15:10 -0700 Subject: [PATCH 3/4] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 6d9cd75..4213bed 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ RTV is built in **python** using the **curses** library. Installation ============ -Install using pip (**recommended**)... +Install using pip (**recommended**) .. code-block:: bash From 775fa04353462f4ca3c6ecab9249d6cf51a22b72 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Tue, 19 Apr 2016 23:18:50 -0700 Subject: [PATCH 4/4] Update README.rst --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 4213bed..32309e2 100644 --- a/README.rst +++ b/README.rst @@ -71,16 +71,16 @@ Move the cursor using either the arrow keys or *Vim* style movement - 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. +See `CONTROLS `_ 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. +RTV enables you to login to your reddit account in order to perform actions like voting and leaving comments. The login process uses OAuth [#]_ and follows these steps: -1. Initiate a login by pressing the ``u`` key. +1. Initiate the login by pressing the ``u`` key. 2. Open a new webpage where reddit will ask you to authorize the application. 3. Click **Accept**. @@ -189,7 +189,7 @@ How do I run the tests? ========= Changelog ========= -Please see `CHANGELOG.rst `_. +Please see `CHANGELOG `_ ======= License