From c8b5538e1c26bb2015480687ef81f7638dabf616 Mon Sep 17 00:00:00 2001 From: Tomas Rivera Date: Mon, 25 May 2026 17:42:42 +0200 Subject: [PATCH] docs: add flake instruction in readme --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index acc182f..2d82a40 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,26 @@ You must also have a [supported editor (and their associated plugin if needed)]( ## How to install +### Nix flakes + +Add this to your inputs in flake.nix: + +```nix +notewrapper = { + url = "github:tomasriveral/notewrapper"; +}; +``` +If your flake already inputs nixpkgs and/or flake-utils, you can follow it: +```nix +notewrapper = { + url = "github:tomasriveral/notewrapper; + inputs.nixpkgs.follow = "nixpkgs"; + inputs.flake-utils.follow = "flake-utils"; +}; +``` + +### Building from source + 1. Install all required dependencies listed above. 2. Ensure you have a supported editor installed. 3. Clone the repository: @@ -89,7 +109,7 @@ make --- -## Packaging +### Packaging There is currently no official package available for NoteWrapper.