From cd7c863c8dcc460b610b249fcc95550802bec675 Mon Sep 17 00:00:00 2001 From: zeno Date: Mon, 2 Dec 2024 20:42:34 +0100 Subject: [PATCH 1/2] docs: include usage --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 4909b2e..53d4d21 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,27 @@ 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 .zip + ``` +3. Include the appropriate package edition from the [Packages section](#Packages) in your packages + ```nix + environment.systemPackages = with pkgs; [ + binaryninja.packages.${pkgs.system}. + ]; + ``` + - replace `` with your chosen edition + ## Packages The following package attributes are available: From c9c9bdd238b77fb2c075542abb176a48da42a901 Mon Sep 17 00:00:00 2001 From: Zenomat Date: Tue, 3 Dec 2024 09:07:29 +0100 Subject: [PATCH 2/2] docs: include download link Co-authored-by: jchv --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 53d4d21..b85f4a1 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Additionally, more variants (e.g. an FHS variant) might be desirable. ```bash nix-store --add-fixed sha256 .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; [