added README.md and moved kernel docs into a seperate directory
This commit is contained in:
parent
956a207ea7
commit
1e393b765f
|
@ -1,2 +1,5 @@
|
|||
# documentation
|
||||
|
||||
The kernel documentation (source, sysabi, etc.) can be found in the `kernel` directory.
|
||||
|
||||
Read `commit-format.md` and `codestyle.md` before contributing to anything!
|
|
@ -1,4 +1,9 @@
|
|||
# Codebase
|
||||
# kernel
|
||||
|
||||
The documentation of the noxos kernel.
|
||||
|
||||
- The source code is documented in the `src` directory.
|
||||
- Build instructions can be found in `build-instructions.md`.
|
||||
- A roadmap of what has to be done can be found in `roadmap.md`.
|
||||
- The kernels' sysabi (syscalls, etc.) can be found in `sysabi.md`.
|
||||
|
||||
Every header in the codebase has its own page.
|
||||
The structure is identically to the codebase directory structure.
|
||||
|
|
|
@ -0,0 +1,4 @@
|
|||
# kernel source
|
||||
|
||||
Every header in the codebase has its own page.
|
||||
The structure is identically to the codebase directory structure.
|
Loading…
Reference in New Issue