From e49bc0b61c10224719baf663d79bc0943299c520 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:17:14 -0400 Subject: [PATCH 1/8] Update and rename README.rst to README.md --- README.rst => README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) rename README.rst => README.md (95%) diff --git a/README.rst b/README.md similarity index 95% rename from README.rst rename to README.md index 8dc8a03..62cebe5 100644 --- a/README.rst +++ b/README.md @@ -1,20 +1,19 @@ -============================ -RTV (Reddit Terminal Viewer) -============================ +# RTV (Reddit Terminal Viewer) -| RTV provides an interface to view and interact with reddit from your terminal. -| It's compatible with *most* terminal emulators on Linux and OS X. +RTV provides an interface to view and interact with reddit from your terminal. +It's compatible with *most* terminal emulators on Linux and OS X. -.. image:: http://i.imgur.com/9utJir2.png +

+title image +

-| -| RTV is built in **python** using the **curses** library. +RTV is built in **python** using the **curses** library. ---------------- +--- |pypi| |python| |travis-ci| |coveralls| |gitter| ---------------- +--- * `Demo`_ * `Installation`_ From b8963e86a0949220dd9e49567f159264f560d8ba Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:17:59 -0400 Subject: [PATCH 2/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 62cebe5..084c177 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # RTV (Reddit Terminal Viewer) -RTV provides an interface to view and interact with reddit from your terminal. +RTV provides an interface to view and interact with reddit from your terminal.
It's compatible with *most* terminal emulators on Linux and OS X.

From 8ec7667ea7b4890b85d39febd9dfdf56920d1d2a Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:24:08 -0400 Subject: [PATCH 3/8] Update README.md --- README.md | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 084c177..dab3ca5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,11 @@ RTV is built in **python** using the **curses** library. --- -|pypi| |python| |travis-ci| |coveralls| |gitter| +[![pypi](https://img.shields.io/pypi/v/rtv.svg?label=version)](https://pypi.python.org/pypi/rtv/) +[![python](https://img.shields.io/badge/python-2.7%2C%203.6-blue.svg)](https://pypi.python.org/pypi/rtv/) +[![travis-ci](https://travis-ci.org/michael-lazar/rtv.svg?branch=master)](https://travis-ci.org/michael-lazar/rtv) +[![coveralls](https://coveralls.io/repos/michael-lazar/rtv/badge.svg?branch=master&service=github)](https://coveralls.io/github/michael-lazar/rtv?branch=master) +[![gitter](https://img.shields.io/gitter/room/michael-lazar/rtv.js.svg)](https://gitter.im/michael-lazar/rtv) --- @@ -225,23 +229,3 @@ This project is distributed under the `MIT Date: Wed, 6 Sep 2017 21:24:41 -0400 Subject: [PATCH 4/8] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index dab3ca5..90f9c3f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # RTV (Reddit Terminal Viewer) RTV provides an interface to view and interact with reddit from your terminal.
-It's compatible with *most* terminal emulators on Linux and OS X.

title image From 8e0d9ff7d831637a4954079bae202806bfb384a1 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:32:13 -0400 Subject: [PATCH 5/8] Update README.md --- README.md | 75 ++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 90f9c3f..09e23a1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # RTV (Reddit Terminal Viewer) RTV provides an interface to view and interact with reddit from your terminal.
+It's compatible with *most* terminal emulators on Linux and OS X.

title image @@ -18,66 +19,62 @@ RTV is built in **python** using the **curses** library. --- -* `Demo`_ -* `Installation`_ -* `Usage`_ -* `Settings`_ -* `FAQ`_ -* `Contributing`_ -* `License`_ +##### Table of Contents -==== -Demo -==== +* [Demo](#demo) +* [Installation](#installation) +* [Usage](#usage) +* [Settings](#settings) +* [FAQ](#faq) +* [Contributing](#contributing) +* [License](#license) -.. image:: http://i.imgur.com/aNZWxnW.gif +## Demo -============ -Installation -============ +

+title image +

--------------- -Python package --------------- +## Installation -RTV is available on `PyPI `_ and can be installed with pip: +### Python package -.. code-block:: bash +RTV is available on [PyPI](https://pypi.python.org/pypi/rtv/) and can be installed with pip: - $ pip install rtv +```bash +$ pip install rtv +``` ---------------- -Native packages ---------------- +### Native packages -Check `Repology `_ for an up-to-date list of supported packages: +Check [Repology](https://repology.org/metapackage/rtv/information) for an up-to-date list of supported packages: **macOS** -.. code-block:: bash - - $ brew install rtv +```bash +$ brew install rtv +``` **Debian 9+, Ubuntu 17.04+** -.. code-block:: bash - - $ apt install rtv +```bash +$ apt install rtv +``` **Fedora 24+** -.. code-block:: bash - - $ yum install rtv +```bash +$ yum install rtv +``` **Arch Linux** -.. code:: bash - - $ # Install the latest official release - $ yaourt -S rtv - $ # Or to keep up to date with the master branch - $ yaourt -S rtv-git +```bash +$ # Install the latest official release +$ yaourt -S rtv +$ # Or to keep up to date with the master branch +$ yaourt -S rtv-git +``` ===== Usage From 33e020b91d5880d1d32b495b7675af53c58d31fa Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:48:10 -0400 Subject: [PATCH 6/8] Update README.md --- README.md | 89 ++++++++++++++++++++++++------------------------------- 1 file changed, 39 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 09e23a1..cdd0a27 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ RTV is built in **python** using the **curses** library. --- -##### Table of Contents +## Table of Contents * [Demo](#demo) * [Installation](#installation) @@ -76,19 +76,15 @@ $ # Or to keep up to date with the master branch $ yaourt -S rtv-git ``` -===== -Usage -===== +## Usage To run the program, type -.. code-block:: bash +```bash +$ rtv --help +``` - $ rtv --help - --------- -Controls --------- +### Controls Move the cursor using either the arrow keys or *Vim* style movement @@ -107,70 +103,63 @@ Press ``/`` to open the navigation prompt, where you can type things like - ``/u/multi-mod/m/art`` - ``/domain/github.com`` -See `CONTROLS `_ 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 -======== +## Settings ------------------- -Configuration File ------------------- +### Configuration File Configuration files are stored in the ``{HOME}/.config/rtv/`` directory -See `rtv.cfg `_ for the full list of configurable options. You can clone this file into your home directory by running +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 -.. code-block:: bash +```bash +$ rtv --copy-config +``` - $ rtv --copy-config - -------------------- -Viewing Media Links +### Viewing Media Links ------------------- -You can use `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 -.. image:: http://i.imgur.com/ueQ3w0P.gif +

+title image +

-| -| A mailcap file allows you to associate different MIME media types, like ``image/jpeg`` or ``video/mp4``, with shell commands. +A mailcap file allows you to associate different MIME media types, like ``image/jpeg`` or ``video/mp4``, with shell commands. This feature is disabled by default because it takes a a few extra steps to configure. To get started, copy the default mailcap template to your home directory. -.. code-block:: bash +```bash +$ rtv --copy-mailcap +``` - $ 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 `_ listed inside. +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 ---------------------- +### Environment Variables 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_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.
+
-``$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 ------------------------- +### Copying to the 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 `_ or `xclip `_. +On Linux systems you will need to install either [xsel](http://www.vergenet.net/~conrad/software/xsel/) or [xclip](https://sourceforge.net/projects/xclip/). === FAQ From 47c9c296063823cc9c673100d1091a5618d51d66 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:55:45 -0400 Subject: [PATCH 7/8] Update README.md --- README.md | 75 ++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index cdd0a27..0bcc52c 100644 --- a/README.md +++ b/README.md @@ -126,9 +126,7 @@ You can use [mailcap](https://en.wikipedia.org/wiki/Media_type#Mailcap) to confi title image

-A mailcap file allows you to associate different MIME media types, like ``image/jpeg`` or ``video/mp4``, with shell commands. - -This feature is disabled by default because it takes a a few extra steps to configure. To get started, copy the default mailcap template to your home directory. +A mailcap file allows you to associate different MIME media types, like ``image/jpeg`` or ``video/mp4``, with shell commands. This feature is disabled by default because it takes a a few extra steps to configure. To get started, copy the default mailcap template to your home directory. ```bash $ rtv --copy-mailcap @@ -166,51 +164,50 @@ FAQ === 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 - .. code-block:: 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 `_ - 4. Your python may have been built against the wrong curses library, - see `here `_ and - `here `_ for more information + +> 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**. - .. code-block:: bash +> 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 +> ``` - $ cd ~/rtv_project - $ python3 -m rtv - -============ -Contributing -============ +## Contributing All feedback and suggestions are welcome, just post an issue! -Before writing any code, please read the `Contributor Guidelines `_. +Before writing any code, please read the [Contributor Guidelines](https://github.com/michael-lazar/rtv/blob/master/CONTRIBUTING.rst). -======= -License -======= -This project is distributed under the `MIT `_ license. +## License +This project is distributed under the [MIT](https://github.com/michael-lazar/rtv/blob/master/LICENSE) license. - -.. figure:: http://i.imgur.com/quDzox3.png - :target: https://github.com/Swordfish90/cool-retro-term +

+title image +

From 291affeedc720c693e67d163518692831482c102 Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Wed, 6 Sep 2017 21:57:25 -0400 Subject: [PATCH 8/8] Update README.md --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0bcc52c..b39647e 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,6 @@ $ 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 @@ -159,11 +158,9 @@ 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/). -=== -FAQ -=== +## 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 @@ -176,7 +173,7 @@ Why am I getting an error during installation/when launching rtv? > $ sudo pip3 install -U rtv > ``` -Why do I see garbled text like ``M-b~@M-"`` or ``^@``? +**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. @@ -188,7 +185,7 @@ Why do I see garbled text like ``M-b~@M-"`` or ``^@``? > 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? +**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