From 503cbbc5cb4fc68a7eb689fd8e75458b5a48f21b Mon Sep 17 00:00:00 2001
From: Joshua Goins <josh@redstrate.com>
Date: Mon, 22 Apr 2024 16:20:04 -0400
Subject: [PATCH] Note that git submodules must be cloned

---
 BUILDING.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/BUILDING.md b/BUILDING.md
index 3af86dc..89d66e6 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -14,12 +14,26 @@ Currently the only way to build Novus is manually.
 * [Rust](https://www.rust-lang.org/)
 * [Corrosion](https://github.com/corrosion-rs/corrosion)
 
+### Getting source code
+
+Novus has git submodules that must be cloned alongside the repository, so make sure to pass the `--recursive` flag:
+
+```bash
+$ git clone --recursive https://github.com/redstrate/Novus.git
+```
+
+If you missed it, it's possible to initialize the submodules afterward:
+
+```bash
+$ git submodule update --init --recursive
+```
+
 ### Configuring
 
 To configure, run `cmake` in the source directory:
 
 ```bash
-$ cd novus
+$ cd Novus
 $ cmake -S . -B build
 ```