hyprshell/README.md
2025-08-10 00:15:24 -06:00

53 lines
1.3 KiB
Markdown

# The Grind - HyprShell
A future starter shell for HyprLand.
## Testing and Development
1. Clone the repository and cd into it
2. `make dev` to get a working quickshell
3. `make cleanup` to stop the `quickshell` process and unlink the directories
This will symlink the repo to `~/.config/quickshell` and start the quickshell process. You'll be able to see your
changes as you work.
## Installation
### Touch Grass Method
To install it permanently, you just have to copy the contents of the repo
to `~/.config/quickshell`. Do that how you must.
After it's installed, just add `quickshell -c hyprshell &` to your hyprland `exec-once` block.
### Nix Flake (The Real Cool Way)
Add this to your `flake.nix`. Make sure you have the home manager module.
```nix
inputs = {
hyprshell.url = "git+https://gitgud.foo/thegrind/hypr-shell.git";
};
```
Then, either throw this in your `configuration.nix`:
```nix
# Enable home manager
home-manager = {
extraSpecialArgs = { inherit inputs; };
users.[your username].imports = inputs.hyprshell.homeManagerModules.default;
}
```
Or, if you load home manager in your flake:
```nix
homeConfigurations = {
modules = [
inputs.hyprshell.homeManagerModules.default
# Other files/inputs
];
};
};
```