diff --git a/README.md b/README.md index 1ca52b4..cb7b254 100644 --- a/README.md +++ b/README.md @@ -84,89 +84,11 @@ Defaults from `CMakeLists.txt`: - shell config install dir: `etc/xdg/quickshell/zshell` - greeter install dir: `etc/xdg/quickshell/zshell-greeter` -### Nix Flake +### Nix -_Note that Nix is not actively developed at this point. Things may be broken. Feel free to suggest fixes in a PR_ +Nix support has been removed. Reason being that none of us actively develop for Nix. Having a `flake.nix` in the project will give the wrong idea. -The flake exposes: - -- `packages..zshell` -- `packages..zshell-cli` - -Add it as an input in your system flake: - -```nix -{ - inputs = { - nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; - z-bar-qt = { - url = git+https://git.zach-dev.cc/zach/z-bar-qt.git - inputs.nixpkgs.follows = "nixpkgs"; - }; - }; -} -``` - -Full `flake.nix` example (`nixosConfigurations`): - -```nix -{ - inputs = { - nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; - z-bar-qt = { - url = git+https://git.zach-dev.cc/zach/z-bar-qt.git - inputs.nixpkgs.follows = "nixpkgs"; - }; - }; - - outputs = inputs@{ nixpkgs, ... }: - let - system = "x86_64-linux"; - in { - nixosConfigurations.my-host = nixpkgs.lib.nixosSystem { - inherit system; - specialArgs = { inherit inputs; }; - modules = [ - ({ ... }: { - environment.systemPackages = [ - inputs.z-bar-qt.packages.${system}.zshell - inputs.z-bar-qt.packages.${system}.zshell-cli - ]; - }) - ./configuration.nix - ]; - }; - }; -} -``` - -Then install shell + CLI from the flake packages: - -```nix -{ pkgs, inputs, ... }: -let - system = pkgs.stdenv.hostPlatform.system; -in { - environment.systemPackages = [ - inputs.z-bar-qt.packages.${system}.zshell - inputs.z-bar-qt.packages.${system}.zshell-cli - ]; -} -``` - -If you use Home Manager, the same packages can be added to `home.packages`. - -Run shell via wrapper binary: - -```bash -zshell -``` - -CLI entrypoint: - -```bash -zshell-cli -``` +Contributions for Nix support are welcome, the caveat being that reviews of these contributions can be of lower quality. ## Running