README: Mention about git submodule

Co-authored-by: Ivan Velickovic <[email protected]> Signed-off-by: Yifei Zhan <[email protected]>
au-ts · Jan 8, 2025 · 35a07d3 · 35a07d3
1 parent 29aceb2
commit 35a07d3
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -67,6 +67,14 @@ nix-shell
 
 ### Building and running
 
+First, initialize the repository:
+
+```sh
+git clone https://github.com/au-ts/libvmm
+cd libvmm
+git submodule update --init
+```
+
 Finally, we can simulate a basic system with a single Linux guest with the
 following commands:
 ```sh