diff --git a/THEMES.md b/THEMES.md new file mode 100644 index 0000000..481d79a --- /dev/null +++ b/THEMES.md @@ -0,0 +1,129 @@ +# Themes + +Different themes can be used to customize the look and feel of RTV. +They control the color and special attributes (bold, underline, etc.) of +every text element drawn on the screen. + +## Usage + +Use the ``--theme`` flag to select a theme: + +```bash +$ rtv --theme=papercolor +``` + +You can also view a list of built-in and installed themes by using the ``--list-themes`` flag: + +```bash +$ rtv --list-themes + +Installed (~/.config/rtv/themes/): + (empty) + +Presets: + molokai [requires 256 colors] + papercolor [requires 256 colors] + solarized-dark [requires 256 colors] + solarized-light [requires 256 colors] + +Built-in: + default [requires 8 colors] + monochrome [requires 0 colors] +``` + +Custom themes can be installed by copying them into the **{HOME}/.config/rtv/themes/** folder. + +RTV allows you to cycle through themes using the F2 & F3 keys. +This can be used to quickly preview the different options. + +## Preview + +
|
+ Default
+ This theme is designed to work with the terminal's preset 16 color palette +
+ |
+
+ Monochrome
+ This theme is a fallback for terminals that don't support colors +
+ |
+
+ Solarized Dark
+
+ |
+
+ Solarized Light
+
+ |
+
+ Papercolor
+
+ |
+
+ Molokai
+
+ |
+