Merge (#32) from tomasriveral/readme-flake

docs: add flake instruction in readme

.envrc

@@ -1 +1 @@
-use nix
+use flake

.github/workflows/weeklyUpdate.yml

@@ -0,0 +1,58 @@
+name: Weekly Flake Update
+
+on:
+  schedule:
+    - cron: "0 3 * * 1"  # every Monday at 03:00 UTC
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  flake_update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: DeterminateSystems/nix-installer-action@v12
+
+      - name: Set branch name (date)
+        id: vars
+        run: |
+          echo "branch=flake-update/$(date +%Y-%m-%d)" >> $GITHUB_OUTPUT
+
+      - name: Create update branch
+        run: |
+          git checkout -B ${{ steps.vars.outputs.branch }}
+
+      - name: Update flake inputs
+        run: |
+          nix flake update
+
+      - name: Commit changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add flake.lock
+          git commit -m "chore: weekly flake update" || echo "No changes to commit"
+
+      - name: Push branch
+        run: |
+          git push origin ${{ steps.vars.outputs.branch }} --force
+
+      - name: Install GitHub CLI
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y gh
+
+      - name: Create Pull Request
+        run: |
+          gh pr create \
+            --base main \
+            --head ${{ steps.vars.outputs.branch }} \
+            --title "[Automated] Weekly flake update $(date +%Y-%m-%d)" \
+            --body "Automated weekly update of flake inputs for $(date +%Y-%m-%d)."
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -8,3 +8,4 @@ result
 massif.out.*
 *.out.*
 vgcore.*
+.direnv/

README.md

@@ -1,5 +1,7 @@
 # NoteWrapper
 
+Note: This project fullfills all my usecases for now, so my main source for features ideas dried out. So if you have good ideas, feel free to open an issue ;)
+
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tomasriveral/notewrapper)
 
 ## Why?
@@ -55,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:
@@ -87,7 +109,7 @@ make
 
 ---
 
-## Packaging
+### Packaging
 
 There is currently no official package available for NoteWrapper.
 

default.nix

@@ -1,35 +0,0 @@
-{ pkgs ? import <nixpkgs> {} }:
-
-pkgs.stdenv.mkDerivation {
-  pname = "notewrapper";
-  version = "1.0";
-
-  src = ./.;
-
-  nativeBuildInputs = [
-    pkgs.pkg-config
-  ];
-
-  buildInputs = [
-    pkgs.ncurses
-    pkgs.cjson
-    pkgs.fzf
-    pkgs.gnused
-    pkgs.ripgrep
-  ];
-
-  buildPhase = ''
-    make
-  '';
-
-  installPhase = ''
-    mkdir -p $out/bin
-    cp notewrapper $out/bin/
-  '';
-
-  meta = with pkgs.lib; {
-    description = " Journaling and notetaking TUI wrapper on top of neovim, vim and nano.";
-    license = licenses.gpl3Only;
-    platforms = platforms.linux;
-  };
-}

flake.lock

@@ -0,0 +1,78 @@
+{
+  "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": 1779508470,
+        "narHash": "sha256-Ap9KJX+5xHIn3bPIpfNgT6MEXdAECECwo4/rmlQD74M=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "29916453413845e54a65b8a1cf996842300cd299",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "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",
+        "notewrapper": "notewrapper"
+      }
+    },
+    "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
+}

flake.nix

@@ -0,0 +1,70 @@
+{
+  description = "NoteWrapper";
+
+  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, notewrapper }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs { inherit system; };
+      in {
+        packages.default = pkgs.stdenv.mkDerivation (finalAttrs: {
+          pname = "notewrapper";
+          version = "2.0";
+
+          src = notewrapper;
+
+          nativeBuildInputs = with pkgs; [
+            pkg-config
+            gnumake
+          ];
+
+          buildInputs = with pkgs; [
+            ncurses
+            cjson
+            vivify
+            rsync
+            ripgrep
+            fzf
+            gnused
+          ];
+
+          makeFlags = [
+            "VERSION=2.0"
+          ];
+
+          buildPhase = ''
+            make
+          '';
+
+          installPhase = ''
+            mkdir -p $out/bin
+            cp notewrapper $out/bin/
+          '';
+        });
+
+        devShells.default = pkgs.mkShell {
+          packages = with pkgs; [
+            cjson
+            ncurses
+            pkg-config
+            gdb
+            valgrind
+            clang-tools
+            gnumake
+          ];
+        };
+
+        apps.default = {
+          type = "app";
+          program = "${self.packages.${system}.default}/bin/notewrapper";
+        };
+      });
+}

shell.nix

@@ -1,13 +0,0 @@
-{ pkgs ? import <nixpkgs> {} }:
-
-pkgs.mkShell {
-  buildInputs = [
-    pkgs.cjson
-    pkgs.ncurses
-    pkgs.pkg-config
-    pkgs.gdb
-    pkgs.valgrind
-    pkgs.kdePackages.kcachegrind
-    pkgs.clang-tools
-  ];
-}