docs: add warning to nix flake

headblockhead · Nov 17, 2024 · 621214e · 621214e
1 parent 54f43c4
commit 621214e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/flake.nix b/flake.nix
@@ -19,6 +19,8 @@
               gcovr
             ];
           };
+          # Reminder! If you want to use SQUIRREL as a library in one of your projects, you MUST build it yourself by adding the directory to your project with CMAKE and changing SQUIRREL_KEYCOUNT, for example:
+          # add_compile_definitions(SQUIRREL_KEYCOUNT=100)
           packages.squirrel = pkgs.stdenv.mkDerivation {
             name = "squirrel";
             src = ./.;