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.

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

README: update install instructions #56

Merged
merged 2 commits into from
Jul 14, 2023
Merged
Changes from all commits
Commits
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
46 changes: 5 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,56 +7,20 @@ run it from whatever location it happens to occupy in `nixpkgs` without really t

## Installation

- Nix with [Flakes](https://nixos.wiki/wiki/Flakes):
comma is in nixpkgs so you can install it just like any other package.

```bash
$ nix profile install github:nix-community/comma
```

- No flakes:
either install it in your nix environment

```bash
$ nix-env -i -f "https://github.com/nix-community/comma/archive/master.tar.gz"
```

## NixOS installation

- No flakes:

replace "v1.2.0" with the latest version

```nix
environment.systemPackages =
let
comma = (import (pkgs.fetchFromGitHub {
owner = "nix-community";
repo = "comma";
rev = "v1.2.0";
sha256 = "0000000000000000000000000000000000000000000000000000";
})).default;
in [ comma ];
nix-env -f '<nixpkgs>' -iA comma
```


- Flakes

Add
or add this snippet to your NixOS configuration.

```nix
inputs.comma = {
url = "github:nix-community/comma";
};
environment.systemPackages = with pkgs; [ comma ];
```

to inputs

and

`inputs.comma.overlays.default` (or comma without `inputs.` if you use explicit input arguments)

to nixpkgs.overlays


## Usage

```bash
Expand Down