From f14fd5d93c0b2dac7a536de5eb3e49c41fc5eafe Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 7 Dec 2017 23:15:49 -0500 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4ea8763..38c6e3f 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ 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](CONTROLS.rst) for the full list of commands. ## Settings @@ -115,7 +115,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](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 @@ -135,7 +135,7 @@ 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. +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](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**) @@ -174,44 +174,42 @@ Use the ``--theme`` flag to enable an alternate color theme, or set it permanent $ rtv --theme=papercolor ``` -You can also use the F2 & F3 keys to cycle through available themes. +You can also use the F2 & F3 keys to cycle through available themes:
-

Default
- Uses the terminal's preset 16 color palette

- +

Default

+
-

Monochrome
- Fallback for terminals that don't support colors

- +

Monochrome

+

Solarized Dark

- +

Solarized Light

- +

Papercolor

- +

Molokai

- +
-For instructions on writing your own RTV theme, see [THEMES.md](THEMES.md) +See [THEMES.md](THEMES.md) for instructions on how to create your own theme. ## FAQ @@ -261,8 +259,8 @@ For instructions on writing your own RTV theme, see [THEMES.md](THEMES.md) ## Contributing All feedback and suggestions are welcome, just post an issue! -Before writing any code, please read the [Contributor Guidelines](https://github.com/michael-lazar/rtv/blob/master/CONTRIBUTING.rst). +Before writing any code, please read the [Contributor Guidelines](CONTRIBUTING.rst). ## License -This project is distributed under the [MIT](https://github.com/michael-lazar/rtv/blob/master/LICENSE) license. +This project is distributed under the [MIT](LICENSE) license.