feat: add Nix flake support and instructions#118
feat: add Nix flake support and instructions#118TheFacc wants to merge 1 commit intoYakitrak:mainfrom
Conversation
|
Hey thanks for submitting an MR. I don't know much about Nix but building from source already works for Nix users, and I'd prefer not to take on the maintenance burden of flake files. I believe a Nixpkgs submission would be the better home for this. |
|
Hi, totally understandable, in fact my first move was just editing About maintainance: there is no maintainance needed, the flake can remain unchanged forever, the Also, I never submitted to nixpkgs. Yet. That might be a real maintainance! :) Would it be ok to just merge a change regarding the readme only, no new files? |
Nix Flake support + Installation/Run instructions for Nix users
Description
Installation instructions for Nix/NixOS users.
Add a repo-root flake (
flake.nix,flake.lock) that allows Nix users to run/build the package directly with e.g.nix run github:Yakitrak/notesmd-cli -- list-vaultsor also easily build the binary, or use the package in a shell, as per instructions.
Also supports future versions with e.g.
nix run github:Yakitrak/notesmd-cli/v0.3.5 -- --helpMotivation and Context
There is no Nixpkgs package yet for this repo; the flake gives Nix users a simple command to use the package, and
flake.lockensures future reproducibility. Also, installation instructions for non-flake Nix users.Checklist: