add git submodules to readme

unavi-xyz · Sep 20, 2024 · e912a2d · e912a2d
1 parent de2c329
commit e912a2d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/crates/unavi-app/README.md b/crates/unavi-app/README.md
@@ -22,4 +22,12 @@ cargo install wac-cli
 
 [Cap'n Proto](https://capnproto.org/install.html) must be installed to compile networking schemas.
 
+#### Git Submodules
+
+Make sure your Git submodules have been initialized:
+
+```bash
+git submodule update --init
+```
+
 <!-- cargo-rdme end -->
diff --git a/crates/unavi-app/src/lib.rs b/crates/unavi-app/src/lib.rs
@@ -17,6 +17,14 @@
 //! ## Cap'n Proto
 //!
 //! [Cap'n Proto](https://capnproto.org/install.html) must be installed to compile networking schemas.
+//!
+//! ### Git Submodules
+//!
+//! Make sure your Git submodules have been initialized:
+//!
+//! ```bash
+//! git submodule update --init
+//! ```
 
 use std::sync::Arc;