diff --git a/README.md b/README.md new file mode 100644 index 0000000..cafe4a6 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# The Grind - HyprShell + +A future starter shell for HyprLand. + +## Testing and Development + +1. Clone the repository and cd into it +2. `make dev` + +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 + +To install it permanently, you just have to copy the contents of the repo +to `~/.config/quickshell`. Do that how you must. \ No newline at end of file