docs(readme): adjust Nix support documentation
JS/TS / fmt (pull_request) Successful in 7s
JS/TS / lint (pull_request) Successful in 8s
Python / static (pull_request) Successful in 27s
Rust / build (pull_request) Successful in 50s
Rust / fmt (pull_request) Successful in 32s
Python / verify (pull_request) Successful in 2m16s
C++ / fmt (pull_request) Failing after 7s
C++ / build (pull_request) Failing after 12s
Rust / clippy (pull_request) Successful in 50s
C++ / clang-tidy (pull_request) Failing after 26s
JS/TS / fmt (pull_request) Successful in 7s
JS/TS / lint (pull_request) Successful in 8s
Python / static (pull_request) Successful in 27s
Rust / build (pull_request) Successful in 50s
Rust / fmt (pull_request) Successful in 32s
Python / verify (pull_request) Successful in 2m16s
C++ / fmt (pull_request) Failing after 7s
C++ / build (pull_request) Failing after 12s
Rust / clippy (pull_request) Successful in 50s
C++ / clang-tidy (pull_request) Failing after 26s
This commit is contained in:
@@ -84,89 +84,11 @@ Defaults from `CMakeLists.txt`:
|
|||||||
- shell config install dir: `etc/xdg/quickshell/zshell`
|
- shell config install dir: `etc/xdg/quickshell/zshell`
|
||||||
- greeter install dir: `etc/xdg/quickshell/zshell-greeter`
|
- 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:
|
Contributions for Nix support are welcome, the caveat being that reviews of these contributions can be of lower quality.
|
||||||
|
|
||||||
- `packages.<system>.zshell`
|
|
||||||
- `packages.<system>.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
|
|
||||||
```
|
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user