From 8b94f8a7ed57af0b5bfad7da072ee213a530441f Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 12 Dec 2021 11:25:53 +0100 Subject: doc: add screenshots to readme --- README.rst | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 15cf652..79f7cac 100644 --- a/README.rst +++ b/README.rst @@ -9,23 +9,32 @@ Color schemes Use ``vtcol colors`` to manipulate the console palette. -**vtcol** knows two ways of loading a color scheme: From a set of predefined -palettes or by loading it from a definition file. The latter accepts input in -the format supported by setcolors_. (Not much effort has been put into ensuring -compliance so YMMV.) Check the subdirectory ``./schemes`` in the **vtcol** tree -for examples of definition files. +.. image:: ./doc/img/solarized.png -Three color schemes are predefined: +**vtcol** loads color schemes from various source: From a set of predefined +palettes, from a binary dump or by loading it from a definition file. The +latter supports input in the format used by setcolors_. (Not much effort has +been put into ensuring compliance so YMMV.) Check the subdirectory +``./schemes`` in the **vtcol** tree for examples of definition files. + +Four color schemes are predefined: * ``default`` the default color scheme of the Linux console. * ``solarized`` the Solarized_ color scheme, dark version. * ``solarized_light`` the Solarized_ color scheme, light version. + * ``phosphor`` monochrome green text on black background. Invoke **vtcol** with the ``set`` command specifying the scheme of your choice: :: $ vtcol colors set solarized_light +Or for a more 80s look’n’feel: :: + + $ vtcol colors set phosphor + +.. image:: ./doc/img/phosphor.png + In order to view the available schemes, use the ``list`` command. Should the scheme specified not resolve to one of the predefined ones, **vtcol** will fall back on interpreting the name as that of a file. Likewise, loading a scheme -- cgit v1.2.3