From 5ca5e0546c0a52995d16529966831b1d1eb3739d Mon Sep 17 00:00:00 2001 From: Jakub Date: Sun, 12 Jul 2026 21:13:09 +0800 Subject: [PATCH] submodule instructions --- README.org | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index e86e623..192f7bf 100644 --- a/README.org +++ b/README.org @@ -40,7 +40,8 @@ If you're new to Node.js development, start with ~npm i~ to install all dependen You may also wish to install LIPS globally with ~npm -g install lips~, which will allow you to run a local repl with the ~lips~ command. This is not required to use this framework, but is recommended. -You should also run ~npm run nitinol:update~ to pull in the Nitinol library files. +The Nitinol libraries are included in this template as a git submodule under ~lib/nitinol~. +You can pull it in when cloning this template with ~git clone --recurse-submodules~, or ~git submodule update --init~ if you have already cloned the repository. Then, the command ~npm run preview~ will start the backend and frontend. @@ -53,4 +54,3 @@ There are 3 main folders in this template that you should pay attention to. - The Nitinol libraries are made automatically available to ~app.scm~ via a script tag in the HTML template. - ~server~ contains all backend server code, with the ~server.scm~ file being the entry point used to start the backend. - ~lib~ contains libraries potentially shared between the front and back end, as well as [[https://git.cyan.sh/BirDt/nitinol][Nitinol]] LIPS libraries included as a git submodule. - - ~npm run nitinol:update~ will update the Nitinol submodule.