From d1dcddba7f267c469374ca4f01fc26bfd27ebab7 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:21:37 -0400 Subject: [PATCH 01/10] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 93971d4..8390bf8 100644 --- a/README.md +++ b/README.md @@ -98,13 +98,13 @@ $ 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 ``space`` to expand/collapse comments -- Press ``u`` to login -- Press ``?`` to open the help screen +- Press ▲ and ▼ to scroll through submissions +- Press ▶ to view the selected submission and ◀ to return +- Press space-bar to expand/collapse comments +- Press u to login +- Press ? to open the help screen -Press ``/`` to open the navigation prompt, where you can type things like +Press / to open the navigation prompt, where you can type things like - ``/front`` - ``/r/commandprompt+linuxmasterrace`` From 5add18becb57d241e39ee19eb69123ca80674b2a Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:27:50 -0400 Subject: [PATCH 02/10] Update README.md --- README.md | 71 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 8390bf8..2f3d46e 100644 --- a/README.md +++ b/README.md @@ -170,41 +170,48 @@ On Linux systems you will need to install either [xsel](http://www.vergenet.net/ ## FAQ -**Why am I getting an error during installation/when launching rtv?** +
+ Why am I getting an error during installation/when launching rtv? + + > If your distro ships with an older version of python 2.7 or python-requests, + > you may experience SSL errors or other package incompatibilities. The + > easiest way to fix this is to install rtv using python 3. If you + > don't already have pip3, see http://stackoverflow.com/a/6587528 for setup + > instructions. Then do + > + > ```bash + > $ sudo pip uninstall rtv + > $ sudo pip3 install -U rtv + > ``` -> If your distro ships with an older version of python 2.7 or python-requests, -> you may experience SSL errors or other package incompatibilities. The -> easiest way to fix this is to install rtv using python 3. If you -> don't already have pip3, see http://stackoverflow.com/a/6587528 for setup -> instructions. Then do -> -> ```bash -> $ sudo pip uninstall rtv -> $ sudo pip3 install -U rtv -> ``` +
+
+ Why do I see garbled text like M-b~@M-" or ^@? + + > This type of text usually shows up when python is unable to render + > unicode properly. + > + > 1. Try starting RTV in ascii-only mode with ``rtv --ascii`` + > 2. Make sure that the terminal/font that you're using supports unicode + > 3. Try [setting the LOCALE to utf-8](https://perlgeek.de/en/article/set-up-a-clean-utf8-environment) + > 4. Your python may have been built against the wrong curses library, + > see [here](stackoverflow.com/questions/19373027) and + > [here](https://bugs.python.org/issue4787) for more information -**Why do I see garbled text like** ``M-b~@M-"`` **or** ``^@`` **?** +
+
+ How do I run the code directly from the repository? + + > This project is structured to be run as a python *module*. This means that + > you need to launch it using python's ``-m`` flag. See the example below, which + > assumes that you have cloned the repository into the directory **~/rtv_project**. + > + > ```bash + > $ cd ~/rtv_project + > $ python3 -m rtv + > ``` -> This type of text usually shows up when python is unable to render -> unicode properly. -> -> 1. Try starting RTV in ascii-only mode with ``rtv --ascii`` -> 2. Make sure that the terminal/font that you're using supports unicode -> 3. Try [setting the LOCALE to utf-8](https://perlgeek.de/en/article/set-up-a-clean-utf8-environment) -> 4. Your python may have been built against the wrong curses library, -> see [here](stackoverflow.com/questions/19373027) and -> [here](https://bugs.python.org/issue4787) for more information - -**How do I run the code directly from the repository?** - -> This project is structured to be run as a python *module*. This means that -> you need to launch it using python's ``-m`` flag. See the example below, which -> assumes that you have cloned the repository into the directory **~/rtv_project**. -> -> ```bash -> $ cd ~/rtv_project -> $ python3 -m rtv -> ``` +
## Contributing All feedback and suggestions are welcome, just post an issue! From a67a0c0e6a77c761d34e391ad36c153b0efd02a7 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:28:41 -0400 Subject: [PATCH 03/10] Update README.md --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 2f3d46e..75cf87a 100644 --- a/README.md +++ b/README.md @@ -220,8 +220,4 @@ Before writing any code, please read the [Contributor Guidelines](https://github ## License This project is distributed under the [MIT](https://github.com/michael-lazar/rtv/blob/master/LICENSE) license. - -

-title image -

From 9f79254da55361dba1dc0135228b59e50c2e3355 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:34:10 -0400 Subject: [PATCH 04/10] Update README.md --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 75cf87a..8ecd63d 100644 --- a/README.md +++ b/README.md @@ -149,21 +149,26 @@ Once you've setup your mailcap file, enable it by launching rtv with the ``rtv - The default programs that RTV interacts with can be configured through environment variables -
-
$RTV_EDITOR
-
A program used to compose text submissions and comments, e.g. vim, emacs, gedit -
If not specified, will fallback to $VISUAL and $EDITOR in that order.
- -
$RTV_BROWSER
-
A program used to open links to external websites, e.g. firefox, google-chrome, w3m, lynx, elinks -
If not specified, will fallback to $BROWSER, or try to intelligently choose a browser supported by your system.
- -
$RTV_URLVIEWER
-
A tool used to extract hyperlinks from blocks of text, e.g.urlview, urlscan -
If not specified, will fallback to urlview if it is installed.
-
-### Copying to the Clipboard + + + + + + + + + + + + + +
$RTV_EDITORA program used to compose text submissions and comments, e.g. vim, emacs, gedit +
If not specified, will fallback to $VISUAL and $EDITOR in that order.
$RTV_BROWSERA program used to open links to external websites, e.g. firefox, google-chrome, w3m, lynx +
If not specified, will fallback to $BROWSER, or your system's default browser
$RTV_URLVIEWERA tool used to extract hyperlinks from blocks of text, e.g. urlview, urlscan +
If not specified, will fallback to urlview if it is installed.
+ +### Clipboard RTV supports copying submission links to the OS clipboard. On macOS this is supported out of the box. On Linux systems you will need to install either [xsel](http://www.vergenet.net/~conrad/software/xsel/) or [xclip](https://sourceforge.net/projects/xclip/). From 610e38641d8939b64a59f78deb5573096cee200f Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:40:16 -0400 Subject: [PATCH 05/10] Update README.md --- README.md | 37 ++++++++++++------------------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8ecd63d..6260651 100644 --- a/README.md +++ b/README.md @@ -57,34 +57,21 @@ $ pip install rtv ### Native packages -Check [Repology](https://repology.org/metapackage/rtv/information) for an up-to-date list of supported packages: - -**macOS** - ```bash -$ brew install rtv +# macOS +brew install rtv + +# Debian 9+, Ubuntu 17.04+ +apt install rtv + +# Fedora 24+ +yum install rtv + +# Arch +yaourt -S rtv ``` -**Debian 9+, Ubuntu 17.04+** - -```bash -$ apt install rtv -``` - -**Fedora 24+** - -```bash -$ yum install rtv -``` - -**Arch Linux** - -```bash -$ # Install the latest official release -$ yaourt -S rtv -$ # Or to keep up to date with the master branch -$ yaourt -S rtv-git -``` +See the up-to-date list of supported packages on [Repology](https://repology.org/metapackage/rtv/information) ## Usage From 0858d984e13d1901c152c630353126e8b93268da Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:40:40 -0400 Subject: [PATCH 06/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6260651..a54aacc 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ yum install rtv yaourt -S rtv ``` -See the up-to-date list of supported packages on [Repology](https://repology.org/metapackage/rtv/information) +See the up-to-date list of supported packages on [Repology](https://repology.org/metapackage/rtv/information). ## Usage From cc666010db48bd5f5bc0df8c394e1d3567d66ae3 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:43:06 -0400 Subject: [PATCH 07/10] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a54aacc..b26afa8 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,8 @@ $ pip install rtv ### Native packages +See [Repology](https://repology.org/metapackage/rtv/information) for an up-to-date list of supported packages: + ```bash # macOS brew install rtv @@ -71,8 +73,6 @@ yum install rtv yaourt -S rtv ``` -See the up-to-date list of supported packages on [Repology](https://repology.org/metapackage/rtv/information). - ## Usage To run the program, type From 6bd89d92bb20f00a210b57dded152c02b8b1fc11 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:45:51 -0400 Subject: [PATCH 08/10] Update README.md --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b26afa8..0445f4b 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ yaourt -S rtv ## Usage -To run the program, type +To run the program, type: ```bash $ rtv --help @@ -83,7 +83,7 @@ $ rtv --help ### Controls -Move the cursor using either the arrow keys or *Vim* style movement +Move the cursor using either the arrow keys or *Vim* style movement: - Press ▲ and ▼ to scroll through submissions - Press ▶ to view the selected submission and ◀ to return @@ -91,7 +91,7 @@ Move the cursor using either the arrow keys or *Vim* style movement - Press u to login - Press ? to open the help screen -Press / to open the navigation prompt, where you can type things like +Press / to open the navigation prompt, where you can type things like: - ``/front`` - ``/r/commandprompt+linuxmasterrace`` @@ -100,15 +100,15 @@ Press / to open the navigation prompt, where you can type things like - ``/u/multi-mod/m/art`` - ``/domain/github.com`` -See [CONTROLS](https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst) for the full list of commands +See [CONTROLS](https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst) for the full list of commands. ## Settings ### Configuration File -Configuration files are stored in the ``{HOME}/.config/rtv/`` directory +Configuration files are stored in the ``{HOME}/.config/rtv/`` directory. -See [rtv.cfg](https://github.com/michael-lazar/rtv/blob/master/rtv/templates/rtv.cfg) for the full list of configurable options. You can clone this file into your home directory by running +Check out [rtv.cfg](https://github.com/michael-lazar/rtv/blob/master/rtv/templates/rtv.cfg) for the full list of configurable options. You can clone this file into your home directory by running ```bash $ rtv --copy-config @@ -116,7 +116,7 @@ $ rtv --copy-config ### Viewing Media Links -You can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to configure how RTV will open different types of links +You can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to configure how RTV will open different types of links.

title image @@ -128,14 +128,11 @@ A mailcap file allows you to associate different MIME media types, like ``image/ $ rtv --copy-mailcap ``` -This template contains examples for common MIME types that work with popular reddit websites like *imgur*, *youtube*, and *gfycat*. Open the mailcap template and follow the [instructions](https://github.com/michael-lazar/rtv/blob/master/rtv/templates/mailcap) listed inside. - -Once you've setup your mailcap file, enable it by launching rtv with the ``rtv --enable-media`` flag (or set it in your **rtv.cfg**) +This template contains examples for common MIME types that work with popular reddit websites like *imgur*, *youtube*, and *gfycat*. Open the mailcap template and follow the [instructions](https://github.com/michael-lazar/rtv/blob/master/rtv/templates/mailcap) listed inside. Once you've setup your mailcap file, enable it by launching rtv with the ``rtv --enable-media`` flag (or set it in your **rtv.cfg**) ### Environment Variables -The default programs that RTV interacts with can be configured through environment variables - +The default programs that RTV interacts with can be configured through environment variables: From 47b6067385c2feb4aa243e4a2c68666ffbb55270 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:46:32 -0400 Subject: [PATCH 09/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0445f4b..9fba85f 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ See [CONTROLS](https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst) fo Configuration files are stored in the ``{HOME}/.config/rtv/`` directory. -Check out [rtv.cfg](https://github.com/michael-lazar/rtv/blob/master/rtv/templates/rtv.cfg) for the full list of configurable options. You can clone this file into your home directory by running +Check out [rtv.cfg](https://github.com/michael-lazar/rtv/blob/master/rtv/templates/rtv.cfg) for the full list of configurable options. You can clone this file into your home directory by running: ```bash $ rtv --copy-config From 2a3f0f7f9425d6c5d1b0f6de5701f0efbe43853c Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:47:25 -0400 Subject: [PATCH 10/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fba85f..f23a6ea 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ The default programs that RTV interacts with can be configured through environme +
If not specified, will fallback to $BROWSER, or your system's default browser.
$RTV_BROWSER A program used to open links to external websites, e.g. firefox, google-chrome, w3m, lynx -
If not specified, will fallback to $BROWSER, or your system's default browser
$RTV_URLVIEWER