From 9091d40c3da72d81a6ad9e5db853339407b64737 Mon Sep 17 00:00:00 2001 From: Chloe M Date: Thu, 9 Jul 2026 21:20:57 -0400 Subject: [PATCH] docs: Add project structure docs Signed-off-by: Chloe M --- README.md | 11 ++++++++++- service/ptos/README.md | 4 ++++ 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 service/ptos/README.md diff --git a/README.md b/README.md index df757fc..cc0078c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,16 @@ PT is built from scratch using its own independent kernel which is inspired from few things from UNIX (e.g., ELF, graphical boot console, etc) and omitting the bad parts (such as ``fork()``, etc). -# Legal +## Top-level directory structure + +``` +artifacts/ - Generated on build, contains the ISO among other things +sdk/ - OS Software Development Kit +service/ - The OS service pack (contains the kernel, apps, bootloader, etc) +tools/ - Host specific tooling (will only work on UNIX-like hosts) +``` + +## Legal This project is licensed under the BSD-3 clause diff --git a/service/ptos/README.md b/service/ptos/README.md new file mode 100644 index 0000000..7b72599 --- /dev/null +++ b/service/ptos/README.md @@ -0,0 +1,4 @@ +# The kernel + +This directory contains kernel sources which are critical for proper system operation as each subsystem manages +resources, scheduling, etc.