docs: add note about submodules

oro-os · Jan 16, 2025 · f550cb5 · f550cb5
1 parent dde7327
commit f550cb5
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -23,7 +23,13 @@ All code necessary to build and run the kernel is provided in this repository.
 The kernel is built standalone and used as a module for a bootloader
 entry point. The kernel does not support being booted to directly.
 
-To build the kernel itself:
+ACPI support uses a submodule; be sure it's checked out (one-time setup):
+
+```shell
+git submodule update --init --recursive
+```
+
+Then, to build the kernel itself:
 
 ```shell
 cargo kernel-x86_64