Merge (#32) from tomasriveral/readme-flake

docs: add flake instruction in readme

.github/workflows/release.yml

@@ -1,59 +0,0 @@
-name: Release PR
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        required: true
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  release_pr:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install GitHub CLI
-        run: sudo apt-get update && sudo apt-get install -y gh
-
-
-      - name: Configure git
-        run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-
-      - uses: DeterminateSystems/nix-installer-action@v12
-
-      - name: Create release branch
-        run: |
-          git checkout -B release/v${{ inputs.version }}
-
-      - name: Set version in flake.nix
-        run: |
-          sed -i "s/version = \".*\";/version = \"${{ inputs.version }}\";/" flake.nix
-
-      - name: Update flake inputs
-        run: nix flake update
-
-      - name: Commit changes
-        run: |
-          git add flake.nix flake.lock
-          git commit -m "chore(release): ${{ inputs.version }}"
-
-      - name: Push branch
-        run: |
-          git push origin release/v${{ inputs.version }}
-
-      - name: Create Pull Request
-        run: |
-          gh pr create \
-            --base main \
-            --head release/v${{ inputs.version }} \
-            --title "[Automatic] Release v${{ inputs.version }}" \
-            --body "Automated release PR.\nAfter the test's succesfull run, create manually a release with a new tag matching `${{ inputs.version }}`"
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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.
 

flake.lock

@@ -34,10 +34,27 @@
         "type": "github"
       }
     },
+    "notewrapper": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1779721342,
+        "narHash": "sha256-QbRzgD4HoUUemaVCIZ2VfiW+SUjzFY2rL51CLOxQLvk=",
+        "owner": "tomasriveral",
+        "repo": "NoteWrapper",
+        "rev": "e370f98c5ebc3c037dec4e7e35f26230724b70d3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "tomasriveral",
+        "repo": "NoteWrapper",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
         "flake-utils": "flake-utils",
-        "nixpkgs": "nixpkgs"
+        "nixpkgs": "nixpkgs",
+        "notewrapper": "notewrapper"
       }
     },
     "systems": {

flake.nix

@@ -4,9 +4,13 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
     flake-utils.url = "github:numtide/flake-utils";
+    notewrapper = {
+      url = "github:tomasriveral/NoteWrapper";
+      flake = false;
+    };
   };
 
-  outputs = { self, nixpkgs, flake-utils }:
+  outputs = { self, nixpkgs, flake-utils, notewrapper }:
     flake-utils.lib.eachDefaultSystem (system:
       let
         pkgs = import nixpkgs { inherit system; };
@@ -15,12 +19,7 @@
           pname = "notewrapper";
           version = "2.0";
 
-          src = pkgs.fetchFromGitHub {
+          src = notewrapper;
-            owner = "tomasriveral";
-            repo = "NoteWrapper";
-            tag = "v${finalAttrs.version}";
-            hash = "sha256-JoI38n5RZ/s0n+Vr9Bri2oiFeyj7Xrt1AmglmcuMpmQ=";
-          };
 
           nativeBuildInputs = with pkgs; [
             pkg-config