nix-packages/README.md
imnyang f2b63501c1
All checks were successful
CI / check (push) Successful in 5s
CI / list-packages (push) Successful in 2s
CI / build (default) (push) Successful in 4s
CI / build (helium) (push) Successful in 4s
CI / build (helium-sync) (push) Successful in 3s
CI / build (pjsk-cursor) (push) Successful in 3s
CI / build (vscode-insiders) (push) Successful in 5s
CI / build (waterfox-bin) (push) Successful in 4s
CI / build (xcursor-mizuki) (push) Successful in 3s
docs: update README with module usage, add binary cache configuration to flake, and fix typo in vscode-insiders workflow
2026-05-08 05:27:03 +09:00

74 lines
1.6 KiB
Markdown

# imnyang Nix Packages
imnyang's custom nixpkgs overlay.
## Included Packages
- `helium`: Helium AppImage wrapper
- `helium-sync`: Helium Sync utility
- `vscode-insiders`: VSCode Insiders
- `waterfox-bin`: Waterfox Browser
- `xcursor-mizuki`: Custom cursor
- `pjsk-cursor`: Custom cursor
[Build Status](https://git.mizuki.guru/imnyang/nix-packages/actions)
## Usage
Add the following to your nix configuration:
```nix
{
inputs = {
nixpkgs.url = "...";
imnyang.url = "git+https://git.mizuki.guru/imnyang/nix-packages.git";
};
outputs = { imnyang, nixpkgs, ... }:
let pkgs = import nixpkgs {
system = "x86_64-linux";
overlays = [ imnyang.overlays.default ];
};
{
# use some packages
};
nixConfig = {
extra-substituters = [
"https://cache.mizuki.guru/public"
];
extra-trusted-public-keys = [
"cache.mizuki.guru:IgipakDD/clr0XbuaIejPYMT5UkTVGKVTxtWXcsbiAg="
];
};
}
```
## Modules
### helium-sync
#### NixOS
```nix
{
inputs.imnyang.url = "git+https://git.mizuki.guru/imnyang/nix-packages.git";
outputs = { self, nixpkgs, imnyang }: {
nixosConfigurations.my-host = nixpkgs.lib.nixosSystem {
modules = [
imnyang.nixosModules.helium-sync
];
};
};
}
```
#### Home Manager
```nix
{
inputs.imnyang.url = "git+https://git.mizuki.guru/imnyang/nix-packages.git";
outputs = { self, home-manager, imnyang, ... }: {
homeConfigurations.my-user = home-manager.lib.homeManagerConfiguration {
modules = [
imnyang.homeManagerModules.helium-sync
];
};
};
}
```