From ce3af3221f214ecd8a40b3ed15dc485e44ad5f51 Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Tue, 8 Oct 2024 11:25:39 -0700 Subject: [PATCH] readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index fc5df8a..08955aa 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,17 @@ yarn symlink This will install dependencies, build all packages, and create symlinks between them. + +### Initialize Submodules + +Before proceeding, make sure to initialize and update the submodules: + +```sh +git submodule update --init --recursive +``` + +This command will initialize and fetch the submodules defined in the project. + ### Running Tests To run tests for a specific package, navigate to the package directory and use the `test:watch` script. For example, to run tests for `@hyperweb/build`: