From 89ba7009fe1097d93100d4195d1b7418951e66c6 Mon Sep 17 00:00:00 2001 From: isabel Date: Wed, 7 Feb 2024 22:31:35 +0000 Subject: [PATCH 1/5] docs: nix installation --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index c2da5ce..cad38e7 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,54 @@ The cutest successor of [`cowsay`](https://en.wikipedia.org/wiki/Cowsay). ## Installation +### Cargo + ```sh cargo install kittysay # or cargo install --git https://github.com/uncenter/kittysay.git ``` +### Nix + +#### Try it out with nix + +```sh +nix run github:uncenter/kittysay/v0.3.0 +# or for the latest version +nix run github:uncenter/kittysay +``` + +
+ + + +#### Installation with flakes + + + +```nix +{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + kittysay.url = "github:uncenter/kittysay"; + }; + + outputs = { self, nixpkgs, kittysay }: { + nixosConfigurations.example = nixpkgs.lib.nixosSystem { + system = "x86_64-linux"; + modules = [{ + environment.systemPackages = [ + inputs.kittysay.packages.${pkgs.system}.default + ]; + }]; + }; + } +} +``` + +
+ ## Usage ``` From 688d9b96842ba69c9c43ed48b246d6f08e4df01c Mon Sep 17 00:00:00 2001 From: isabel Date: Wed, 7 Feb 2024 22:34:18 +0000 Subject: [PATCH 2/5] style: fomating --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cad38e7..ca9a7c0 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ nix run github:uncenter/kittysay }; outputs = { self, nixpkgs, kittysay }: { - nixosConfigurations.example = nixpkgs.lib.nixosSystem { + nixosConfigurations.example = nixpkgs.lib.nixosSystem { system = "x86_64-linux"; modules = [{ - environment.systemPackages = [ - inputs.kittysay.packages.${pkgs.system}.default + environment.systemPackages = [ + inputs.kittysay.packages.${pkgs.system}.default ]; - }]; + }]; }; } } From a373b925259a638344880a1445bcc5d5b0fc0328 Mon Sep 17 00:00:00 2001 From: isabel Date: Wed, 7 Feb 2024 22:42:02 +0000 Subject: [PATCH 3/5] docs: be more accurate with passing args, give 2 examples --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca9a7c0..5e96252 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,9 @@ cargo install --git https://github.com/uncenter/kittysay.git #### Try it out with nix ```sh -nix run github:uncenter/kittysay/v0.3.0 +nix run github:uncenter/kittysay/v0.3.0 ":3" # or for the latest version -nix run github:uncenter/kittysay +nix run github:uncenter/kittysay -- ":3" ```
From 639d560ca3e524733f34b6d0a09882798ff836b1 Mon Sep 17 00:00:00 2001 From: Isabel Date: Thu, 8 Feb 2024 08:04:22 +0000 Subject: [PATCH 4/5] chore: reduce redundant words Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e96252..5541e5c 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ cargo install --git https://github.com/uncenter/kittysay.git ### Nix -#### Try it out with nix +#### Try it out ```sh nix run github:uncenter/kittysay/v0.3.0 ":3" From 6162a71e2d365ae7e5ecccbb4d664de9033c18ae Mon Sep 17 00:00:00 2001 From: Isabel Date: Thu, 8 Feb 2024 08:04:44 +0000 Subject: [PATCH 5/5] docs: more precise wording Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5541e5c..56f015f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ cargo install --git https://github.com/uncenter/kittysay.git ```sh nix run github:uncenter/kittysay/v0.3.0 ":3" -# or for the latest version +# or for the latest commit nix run github:uncenter/kittysay -- ":3" ```