NotAShelf/Basix
1
0
Fork 0
mirror of https://github.com/NotAShelf/Basix.git synced 2024-11-01 08:41:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

clean up readme

Browse source
This commit is contained in:
raf 2024-08-26 20:43:57 +03:00
parent 798488b399
commit dabb8c4d8e
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 18 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -7,8 +7,8 @@ one convenient library.
## How does it work?
For some obscure reason[^1] all schemes provided by tinted-theming is in YAML
under one unified repository. We convert each YAML scheme to JSON to ensure the
schemes are in a format Nix can read, then read them and expose them under a
and under one unified repository. We convert each YAML scheme to JSON to ensure
the schemes are in a format Nix can read, then read them and expose them under a
flake output.
## How do I use this?
@ -46,6 +46,20 @@ nix-repl> :p schemeData.base16.decaf
}
```
## Why?
There are not many theming solutions for Nix. Those that already exist are
either too convoluted, or straight up bad in terms of code quality or/and
execution. This leads me to use (and recommend) home-baked theming modules for
in-home usage, but there was not a good Base16 solution on Nix. Basix aims to
solve this issue by providing you an auto-updated collection of Base16 and
Base24 color palettes. As opposed to traditional hacks needed to convert YAML to
JSON and then read it, you can simply consume attribute sets derived from JSON
schemes while Basix does the heavy lifting for you.
Basix might come in handy in scenarios you wish to theme individual applications
from a pre-defined color palette.
## Credits
- [@Gerg-l](https://github.com/gerg-l) for the clinically insane import