gryf/tuir
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Michael Lazar
2017-12-07 23:15:49 -05:00
committed by GitHub
parent 193b3799d9
commit f14fd5d93c
1 changed files with 15 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -107,7 +107,7 @@ Press <kbd>/</kbd> 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 <kbd>F2</kbd> & <kbd>F3</kbd> keys to cycle through available themes.
You can also use the <kbd>F2</kbd> & <kbd>F3</kbd> keys to cycle through available themes:
<table>
<tr>
<td align="center">
<p><strong>Default</strong><br>
Uses the terminal's preset 16 color palette</p>
<img src="https://github.com/michael-lazar/rtv/blob/themes/resources/theme_default.png"></img>
<p><strong>Default</strong></p>
<img src="resources/theme_default.png"></img>
</td>
<td align="center">
<p><strong>Monochrome</strong><br>
Fallback for terminals that don't support colors</p>
<img src="https://github.com/michael-lazar/rtv/blob/themes/resources/theme_monochrome.png"></img>
<p><strong>Monochrome</strong></p>
<img src="resources/theme_monochrome.png"></img>
</td>
</tr>
<tr>
<td align="center">
<p><strong>Solarized Dark</strong></p>
<img src="https://github.com/michael-lazar/rtv/blob/themes/resources/theme_solarized_dark.png"></img>
<img src="resources/theme_solarized_dark.png"></img>
</td>
<td align="center">
<p><strong>Solarized Light</strong></p>
<img src="https://github.com/michael-lazar/rtv/blob/themes/resources/theme_solarized_light.png"></img>
<img src="resources/theme_solarized_light.png"></img>
</td>
</tr>
<tr>
<td align="center">
<p><strong>Papercolor</strong></p>
<img src="https://github.com/michael-lazar/rtv/blob/themes/resources/theme_papercolor.png"></img>
<img src="resources/theme_papercolor.png"></img>
</td>
<td align="center">
<p><strong>Molokai</strong></p>
<img src="https://github.com/michael-lazar/rtv/blob/themes/resources/theme_molokai.png"></img>
<img src="resources/theme_molokai.png"></img>
</td>
</tr>
</table>
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.