Skip to content

Commit ab2e645

Browse files
authored
Merge pull request #2 from TheOnAndOnlyZenomat/master
docs: include usage instructions
2 parents a99294c + c9c9bdd commit ab2e645

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@ This is an unofficial, experimental Nix flake for running Binary Ninja on NixOS.
44
More testing is needed; currently only `x86-64_linux` is tested, and only a bit.
55
Additionally, more variants (e.g. an FHS variant) might be desirable.
66

7+
## Usage
8+
1. Include the flake in you nix configuration
9+
```nix
10+
binaryninja = {
11+
url = "github:jchv/nix-binary-ninja";
12+
inputs.nixpkgs.follows = "nixpkgs";
13+
};
14+
```
15+
- also include the flake input as an argument to your `outputs`
16+
2. Include the installer in the nix-store, if not using the free version
17+
```bash
18+
nix-store --add-fixed sha256 <path-to-installer>.zip
19+
```
20+
- You can get a copy of the latest release using your registered e-mail address [here](https://binary.ninja/recover/).
21+
3. Include the appropriate package edition from the [Packages section](#Packages) in your packages
22+
```nix
23+
environment.systemPackages = with pkgs; [
24+
binaryninja.packages.${pkgs.system}.<package-attribute>
25+
];
26+
```
27+
- replace `<package-attribute>` with your chosen edition
28+
729
## Packages
830
The following package attributes are available:
931

0 commit comments

Comments
 (0)