Add documentation for nix package

This commit is contained in:
cidkidnix 2022-01-08 09:27:47 -06:00
parent 83fcebe2a9
commit 0ec2170b5e

26
packages/nix/NIX.md Normal file
View File

@ -0,0 +1,26 @@
# How to import
To import with flakes use
```nix
inputs = {
polymc.url = "github:PolyMC/PolyMC";
};
...
nixpkgs.overlays = [ inputs.polymc.overlay ]; ## Within configuration.nix
```
To import without flakes use channels:
```
sudo -i nix-channel --add https://github.com/PolyMC/PolyMC/archive/master.tar.gz polymc
sudo -i nix-channel --update polymc
```
add `<polymc>` to imports in your `configuration.nix`
```nix
imports = [
"<polymc>/packages/nix/overlay.nix
];
```