summaryrefslogtreecommitdiff
path: root/doc/file_structure.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/file_structure.md')
-rw-r--r--doc/file_structure.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/file_structure.md b/doc/file_structure.md
new file mode 100644
index 0000000..0ece193
--- /dev/null
+++ b/doc/file_structure.md
@@ -0,0 +1,16 @@
+# General Structure of project
+
+/
+|--- arch/
+ |--- x86_64/ # GDT, IDT, paging, APIC, arch-specific boot (for more information look at doc/arch/x86_64.md)
+ |--- aarch64/ # MMU setup, GIC, exception vectors and other (fore more information look at doc/arch/aarch64.md)
+|--- core/ # Scheduler, IPC, syscalls, processes
+|--- mm/ # VMM, PMM, head and stack
+|--- fs/ # VFS, initramfs, interfaces for fs drivers
+|--- drivers/ # Framebuffer, UART, block devices, fs, graphic, network
+|--- loader/ # ELF parser and process loader
+|--- lib/ # kprint, string ops, main data structures
+|--- boot/ # UEFI application (and maybe adding something like Limine support and legacy support)
+|--- include/ # header files
+|--- scripts/ # Scripts
+|--- Makefile # Main build file