diff --git a/README.md b/README.md new file mode 100644 index 0000000..d549eac --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# nova-shell + +A minimal [Quickshell](https://quickshell.outfoxxed.me) bar for [niri](https://github.com/YarikTH/ycmd), lovingly hallucinated by a +statistical text blender. Every line of code in this repository was +produced by a glorified autocomplete engine and has not been meaningfully +reviewed by a human with a functioning brain. + +**Use at your own risk.** The slop machine was very confident, which is +exactly when you should be most suspicious. + +## "Features" + +- Bar with workspaces, clock, tray, and a pile of widgets the AI insisted on adding +- Home Manager module (probably works) +- treefmt + nixfmt for formatting, because even AI slop deserves consistent indentation +- Checks via `nix flake check` (the irony of testing AI garbage is not lost on anyone) + +## Installation + +Add the flake input and use the Home Manager module. Good luck — the robot +didn't test any of this on real hardware. + +```nix +inputs.nova-shell.url = "github:yourname/nova-shell"; +``` + +Then in your Home Manager config: + +```nix +imports = [ inputs.nova-shell.homeModules.default ]; + +programs.nova-shell.enable = true; +``` + +## Contributing + +Sure, why not. It can't get much worse. + +## Copyright + +To the extent possible under law, all copyright in this repository is +waived and dedicated to the **public domain**. Do whatever you want with it. +The AI certainly didn't care about ownership when it scraped half the +internet to produce this.