Skip to content

docs: include usage instructions #2

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

Merged
merged 2 commits into from
Dec 3, 2024
Merged

docs: include usage instructions #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd7c863
docs: include usage
TheOnAndOnlyZenomat Dec 2, 2024
c9c9bdd
docs: include download link
TheOnAndOnlyZenomat Dec 3, 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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ This is an unofficial, experimental Nix flake for running Binary Ninja on NixOS.
More testing is needed; currently only `x86-64_linux` is tested, and only a bit.
Additionally, more variants (e.g. an FHS variant) might be desirable.

## Usage
1. Include the flake in you nix configuration
```nix
binaryninja = {
url = "github:jchv/nix-binary-ninja";
inputs.nixpkgs.follows = "nixpkgs";
};
```
- also include the flake input as an argument to your `outputs`
2. Include the installer in the nix-store, if not using the free version
```bash
nix-store --add-fixed sha256 <path-to-installer>.zip
```
- You can get a copy of the latest release using your registered e-mail address [here](https://binary.ninja/recover/).
3. Include the appropriate package edition from the [Packages section](#Packages) in your packages
```nix
environment.systemPackages = with pkgs; [
binaryninja.packages.${pkgs.system}.<package-attribute>
];
```
- replace `<package-attribute>` with your chosen edition

## Packages
The following package attributes are available:

Expand Down