From 4c789d1300f56a5e0240008cc01b28bb50f64f55 Mon Sep 17 00:00:00 2001 From: Vaxry Date: Thu, 7 Mar 2024 18:01:08 +0000 Subject: [PATCH] util: Add readme --- hyprcursor-util/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 hyprcursor-util/README.md diff --git a/hyprcursor-util/README.md b/hyprcursor-util/README.md new file mode 100644 index 0000000..115d807 --- /dev/null +++ b/hyprcursor-util/README.md @@ -0,0 +1,18 @@ +## hyprcursor-util + +A utility to compile, pack, unpack, etc, hyprcursor and xcursor themes. + +## States + +Cursor themes can be in 3 states: + - compiled hyprcursor - these can be used by apps / compositors. + - compiled xcursor - these can be used by xcursor + - working state - an easy to navigate mode where every cursor is a png / svg, and all the meta is in files. + +## Commands + +`--create | -c [path]` -> create a compiled hyprcursor theme from a working state + +`--extract | -x [path]` -> extract an xcursor theme into a working state + +both commands support `--output | -o` to specify an output directory. This directory will be fully overwritten, and by default is `./theme` and `./extracted` respectively. \ No newline at end of file