diff options
| -rw-r--r-- | README.rst | 54 |
1 files changed, 13 insertions, 41 deletions
@@ -53,61 +53,33 @@ as a file name instead. Building -------- -The **vtcol** repository aims at compliance with the standard Rust toolchain. -Consequently, the project is packaged using Cargo_. In order to compile a -binary, run + +Use Cargo to obtain a binary: :: cargo build -In the project root. This should get you a ``vtcol`` binary. - Background ---------- The default palette that comes with a Linux terminal was inherited from a long -history of virtual console implementations. The colors assigned are chosen for -totally valid pragmatic reasons. However, the palette may not harmonize with -everybody’s taste. Unfortunately, the console can’t be themed easily: One needs -to invoke a special ``ioctl(2)`` with the colors prepared in binary form in -order for the kernel to switch the palette. - -**vtcol** attempts at facilitating the themability of the console by means of a -simple plain text input format. The very popular themes from the Solarized_ -family are included as predefined palettes; the same is true of the Linux -default palette, so they can be conveniently restored when experimenting. - -An implementation in C which **vtcols** draws much inspiration from is -available in the setcolors_ utility. **vtcols** itself is implemented in Rust -instead; a public repository is available on Github_. The author uses the -original setcolors_ a lot, primarily inside his custom initramfs. The primary -motivations of writing **vtcols** stems from curiosity as to how the same goal -might be achieved using more modern tools. +history of virtual console implementations. The colors assigned were chosen for +pragmatic reasons but that palette may not harmonize with everybody’s taste. +Enter **vtcol**. + +**vtcol** attempts to make the console colors themeable with a simple plain +text input format. The very popular themes from the Solarized_ family are +included as predefined palettes; the same is true of the Linux default palette, +so they can be conveniently restored when experimenting. About ----- -**vtcols** was written mostly during day-long train rides between Tübingen and -Dresden, so expect the commit history to exhibit a certain lack of -continuity. Its author_ is Philipp Gesang; see the Bitbucket -(author-bb_) and Github (author-gh_) pages. - The **vtcol** source code is available from the `canonical repository`_. - -**vtcol** is redistributable under the terms of the -`GNU General Public License`_ version 3 (exactly). The full text of the -license is contained in the file ``COPYING`` in the root of the -repository. Email the author_ if you wish to use it under a different -license, there’s a non-zero chance that you might convince me. - -Patches or suggestions welcome. +**vtcol** is redistributable under the terms of the `GNU General Public +License`_ version 3 (exactly). Patches or suggestions welcome. .. _setcolors: https://github.com/EvanPurkhiser/linux-vt-setcolors .. _Solarized: http://ethanschoonover.com/solarized -.. _Github: https://github.com/phi-gamma/vtcols -.. _author: mailto:phg@phi-gamma.net -.. _author-bb: https://bitbucket.org/phg -.. _author-gh: https://github.com/phi-gamma -.. _Cargo: https://github.com/rust-lang/cargo .. _GNU General Public License: http://www.gnu.org/licenses/gpl.txt -.. _canonical repository: https://github.com/phi-gamma/vtcol +.. _canonical repository: https://gitlab.com/phgsng/vtcol |