Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add nix installation and running information #5

Merged
merged 5 commits into from
Feb 8, 2024
Merged

docs: add nix installation and running information #5

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89ba700
docs: nix installation
isabelroses Feb 7, 2024
688d9b9
style: fomating
isabelroses Feb 7, 2024
a373b92
docs: be more accurate with passing args, give 2 examples
isabelroses Feb 7, 2024
639d560
chore: reduce redundant words
isabelroses Feb 8, 2024
6162a71
docs: more precise wording
isabelroses Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```sh
nix run github:uncenter/kittysay/v0.3.0 ":3"
# or for the latest commit
nix run github:uncenter/kittysay -- ":3"
```

<details>

<summary>

#### Installation with flakes

</summary>

```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
];
}];
};
}
}
```

</details>

## Usage

```
Expand Down