[META] Format nix README, add maintainer

This commit is contained in:
Ben C 2023-12-28 12:42:16 -05:00
parent 80f2f84111
commit f7107b94af
No known key found for this signature in database
4 changed files with 14 additions and 8 deletions

View File

@ -44,6 +44,7 @@ This is the monorepo for the new <a href="https://www.mobiusdigitalgames.com/out
- [JohnCorby](https://github.com/JohnCorby) - [JohnCorby](https://github.com/JohnCorby)
- [BUNN1E5](https://github.com/BUNN1E5) - [BUNN1E5](https://github.com/BUNN1E5)
- [ShoosGun](https://github.com/ShoosGun) - [ShoosGun](https://github.com/ShoosGun)
- [JSpoonBaker](https://github.com/Spoonbaker)
- Translations: - Translations:
- Chinese: [SmallGarfield](https://github.com/xiaojiafei520) - Chinese: [SmallGarfield](https://github.com/xiaojiafei520)

View File

@ -7,18 +7,22 @@ Alternatively, you can get the latest version from this repo.
## Flakes ## Flakes
The flake provides an overlay and the packages `owmods-cli` and `owmods-gui`. The flake provides an overlay and the packages `owmods-cli` and `owmods-gui`.
```nix ```nix
ow-mod-man = { ow-mod-man = {
url = "github:ow-mods/ow-mod-man/dev"; url = "github:ow-mods/ow-mod-man/dev";
inputs.nixpkgs.follows = "nixpkgs"; inputs.nixpkgs.follows = "nixpkgs";
}; };
``` ```
You can then reference `ow-mod-man.packages.<system>.owmods-<gui/cli>`, or use the overlay, for example: You can then reference `ow-mod-man.packages.<system>.owmods-<gui/cli>`, or use the overlay, for example:
```nix ```nix
nixpkgs.overlays = [ inputs.ow-mod-man.overlays.default ] nixpkgs.overlays = [ inputs.ow-mod-man.overlays.default ]
``` ```
## Without flakes ## Without flakes
If you can't or don't want to use flakes, you can use [flake-compat](https://github.com/edolstra/flake-compat). If you can't or don't want to use flakes, you can use [flake-compat](https://github.com/edolstra/flake-compat).
```nix ```nix
@ -30,5 +34,4 @@ let
}; };
ow-mod-man = (flake-compat { inherit src; }).defaultNix; ow-mod-man = (flake-compat { inherit src; }).defaultNix;
in ow-mod-man.packages.<system>.owmods-<gui/cli> in ow-mod-man.packages.<system>.owmods-<gui/cli>
```
```

View File

@ -33,10 +33,12 @@ rustPlatform.buildRustPackage rec {
lockFile = ../Cargo.lock; lockFile = ../Cargo.lock;
}; };
nativeBuildInputs = [ nativeBuildInputs =
pkg-config [
installShellFiles pkg-config
] ++ lib.optional wrapWithMono makeWrapper; installShellFiles
]
++ lib.optional wrapWithMono makeWrapper;
buildInputs = [ buildInputs = [
openssl openssl
@ -60,6 +62,6 @@ rustPlatform.buildRustPackage rec {
changelog = "https://github.com/ow-mods/ow-mod-man/releases/tag/cli_v${version}"; changelog = "https://github.com/ow-mods/ow-mod-man/releases/tag/cli_v${version}";
mainProgram = "owmods"; mainProgram = "owmods";
license = licenses.gpl3; license = licenses.gpl3;
maintainers = with maintainers; [locochoco]; maintainers = with maintainers; [bwc9876 locochoco];
}; };
} }

View File

@ -100,6 +100,6 @@ rustPlatform.buildRustPackage rec {
mainProgram = "outer-wilds-mod-manager"; mainProgram = "outer-wilds-mod-manager";
platforms = platforms.linux; platforms = platforms.linux;
license = licenses.gpl3; license = licenses.gpl3;
maintainers = with maintainers; [locochoco]; maintainers = with maintainers; [bwc9876 locochoco];
}; };
} }