From 253ee005adfd61b30b406ba73534f4d4ef084851 Mon Sep 17 00:00:00 2001 From: stevensonmt Date: Fri, 12 Aug 2022 13:02:22 -0700 Subject: [PATCH] Improve config documentation (#414) * Improve config documentation update readme to provide some direction on customization options. * move color config info to config.ini Info on configuring color palette moving from README to config.ini comments * Add comments for color config --- res/config.ini | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/res/config.ini b/res/config.ini index 9d96840..45dc7da 100644 --- a/res/config.ini +++ b/res/config.ini @@ -13,6 +13,24 @@ # Erase password input on failure #blank_password = false +#The `fg` and `bg` color settings take a digit 0-8 corresponding to: +#define TB_DEFAULT 0x00 +#define TB_BLACK 0x01 +#define TB_RED 0x02 +#define TB_GREEN 0x03 +#define TB_YELLOW 0x04 +#define TB_BLUE 0x05 +#define TB_MAGENTA 0x06 +#define TB_CYAN 0x07 +#define TB_WHITE 0x08 +# +# Setting both to zero makes `bg` black and `fg` white. To set the actual color palette you are encouraged to use another tool +# such as [mkinitcpio-colors](https://github.com/evanpurkhiser/mkinitcpio-colors). Note that the color palette defined with +# `mkinitcpio-colors` takes 16 colors (0-15), only values 0-8 are valid for `ly` config and these values do not correspond +# exactly. For instance, in defining palettes with `mkinitcpio-colors` the order is black, dark red, dark green, brown, dark +# blue, dark purple, dark cyan, light gray, dark gray, bright red, bright green, yellow, bright blue, bright purple, bright +# cyan, and white, indexed in that order 0 through 15. For example, the color defined for white (indexed at 15 in the mkinitcpio +# config) will be used by `ly` for `fg = 8`. # Background color id #bg = 0