summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 3c4f052..c5c7158 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -20,6 +20,12 @@ amd64
Multiboot (Legacy / UEFI)
+## Docstrings
+
+Kernel function docstrings MUST be located in the headers.
+
+Docstrings for global functions MAY be in the source c files.
+
## Startup
1. Multiboot loads kernel into either `_start` or `_start_efi`