diff --git a/BUILDING.md b/BUILDING.md index b09a0a9..e594909 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -18,6 +18,12 @@ Use your favorite package tool to install dependencies. For example, on Ubuntu: sudo apt install build-essential pkg-config libusb-1.0-0-dev cmake ``` +##### Alternative to install dependencies with nix + +Instead of having to manually install every dependency, it can be managed through [Nix](https://nixos.org/download/) / [Lix](https://lix.systems/install/). + +Before building the project, just use the following command: `nix develop` + Then simply build like a normal CMake project: ```console diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..dd07a27 --- /dev/null +++ b/flake.lock @@ -0,0 +1,60 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1739302066, + "narHash": "sha256-G0n8Kg4fp5ySKtmnpD+97NwQYJWeC2iHvIukq4IIvyw=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "e3ade6a61ec8b56318877de06846d59d86eb2565", + "type": "github" + }, + "original": { + "owner": "NixOS", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..8556c29 --- /dev/null +++ b/flake.nix @@ -0,0 +1,46 @@ +{ + description = "A flake for compiling picotool from Raspberry Pi"; + + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs"; + flake-utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachSystem [ "x86_64-linux" "aarch64-linux" "aarch64-darwin" "x86_64-darwin"] (system: + let + pkgs = import nixpkgs { inherit system; }; + + picoSdk = pkgs.fetchFromGitHub { + owner = "raspberrypi"; + repo = "pico-sdk"; + rev = "master"; + sha256 = "0qzj3x7vqrflirgbxmji2m5fqxha7ib95nsg6glhpn7id7lkb9s0"; + }; + + commonDeps = [ + pkgs.cmake + pkgs.libusb1 + ]; + + macDeps = [ + pkgs.llvmPackages.clang + pkgs.libiconv + ]; + + linuxDeps = [ + pkgs.gcc + ]; + + buildDeps = if pkgs.stdenv.isDarwin then commonDeps ++ macDeps else commonDeps ++ linuxDeps; + + in { + devShells.default = pkgs.mkShell { + buildInputs = buildDeps; + shellHook = '' + export PICO_SDK_PATH=${picoSdk} + echo "PICO_SDK_PATH set to ${picoSdk}" + ''; + }; + }); +}