hyprwm
/
hyprcursor
mirror of https://github.com/hyprwm/hyprcursor.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

util: Add readme

This commit is contained in:
Vaxry 2024-03-07 18:01:08 +00:00
parent a1cf5d72e5
commit 4c789d1300
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
hyprcursor-util/README.md Normal file
View File

@ -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.