-
-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve docs #12
Comments
well the thing is we don't want the "average joe" to convert his themes, because one of the key advantages of hyprcursor is that it supports svg. It's better to clearly direct them to #hyprcursor-themes (or maybe make a common repository of some themes?) and get their themes from there |
Well, okay. At the same time, even converting XCursor theme to its Hypr equivalent is much better due to PNG compression. That's what the util supports ( A quick search of hyprcursor on AUR and GitHub yields a single theme: Pretty lackluster, right? Of course, I understand it's new and all. The point is, the docs don't make it easy to follow your steps:
Took me waaay more time and creating the issue. Having reproducible example(s) in the docs would make them much better. Can we have one? spoilerHaving examples is super helpful, especially compared to multiple `goto docs`:https://github.com/hyprland-community/hyprland-rs/tree/master/examples Even the wrapper around the fresh hyprcursor has an example, how cool is that for the starters? https://github.com/morr0ne/rusty-hyprcursor/blob/main/examples/ |
feel free to make a MR. I am just a developer. |
The current state is like this (my yesterday's experience of trying to convert KDEs Breeze Light to hyprcursor):
Open Hyprland wiki, Hyprcursor. It says go to github
Open this repo. It says go read
./docs
There are 3 files there. Okay, checking all of them
One says go read stuff of
hyprcursor-util
(why isn't the binary justhyprcursor
btw?). Mkay, I guess, somewhat helpful.Time to play with the binary. No
-h/--help
there. Okay, it's C++ after all, there are no CLI parsing libs and adding/mananaging dependencies is kinda pain in the arse (hi,cargo add clap --features derive
).In the end something like this works, but it's not user-freindly and is somewhat time consuming to get there:
It's hard to expect any adoption if such basic scenario isn't trivial to find.
Can we add something like this to main README.md. I would carefully assume that this what an average Joe wants when he tries to switch to new cool
hyprcursor
. Converting an existing XCursor theme should be trivial, if no edits are needed (let's not talk about animations here). I didn't edit anything but name/description in the manifest file, as you can see.The text was updated successfully, but these errors were encountered: