diff --git a/README.md b/README.md index 2391f33..e4d184f 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,16 @@ 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? Basix be used as a flake input, or imported from a tarball. -To get a colorscheme, import either `schemeData.base16` or `schemeData.base24` -from the outputs from this flake to import the colorschemes for yourself. +To get a color scheme, import either `schemeData.base16` or `schemeData.base24` +from the outputs from this flake to import the color schemes for yourself. ```bash nix-repl> :p schemeData.base16.decaf @@ -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 diff --git a/flake.lock b/flake.lock index 674a925..e431bb9 100644 --- a/flake.lock +++ b/flake.lock @@ -1,5 +1,21 @@ { "nodes": { + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1696426674, + "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, "flake-parts": { "inputs": { "nixpkgs-lib": "nixpkgs-lib" @@ -48,6 +64,7 @@ }, "root": { "inputs": { + "flake-compat": "flake-compat", "flake-parts": "flake-parts", "nixpkgs": "nixpkgs" } diff --git a/flake.nix b/flake.nix index 3155cbd..8b96047 100644 --- a/flake.nix +++ b/flake.nix @@ -4,6 +4,10 @@ inputs = { flake-parts.url = "github:hercules-ci/flake-parts"; nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + flake-compat = { + url = "github:edolstra/flake-compat"; + flake = false; + }; }; outputs = inputs @ {