os-k-team/os-k
os-k-team
/
os-k
2
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Introducing documentation

This commit is contained in:
Adrien Bourmault 2020-02-20 21:50:22 +01:00
parent 2d8fb04923
commit bb8a7b2c5a
No known key found for this signature in database
GPG Key ID: AFEE5788AEE3F4EC
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/Documentation
View File

@ -3,13 +3,15 @@
# # # #
# Desc: Summary and some description # # Desc: Summary and some description #
# # # #
# #
# Copyright © 2018-2020 The OS/K Team #
# #
# Permission is granted to copy, distribute and/or modify this # # Permission is granted to copy, distribute and/or modify this #
# document under the terms of the GNU Free Documentation License, # # document under the terms of the GNU Free Documentation License, #
# Version 1.3 or any later version published by the Free Software # # Version 1.3 or any later version published by the Free Software #
# Foundation; with no Invariant Sections, no Front-Cover Texts, and # # Foundation; with no Invariant Sections, no Front-Cover Texts, and #
# no Back-Cover Texts. A copy of the license is included in the # # no Back-Cover Texts. A copy of the license is included in the #
# file entitled "COPYING.GFDL" # # file entitled "COPYING.GFDL" #
# #
#=----------------------------------------------------------------------------=# #=----------------------------------------------------------------------------=#
@ -18,6 +20,17 @@ documentation, whose goals are to explain, describe and a bit formalize the main
principles of our project. As written in the header of each file, we release principles of our project. As written in the header of each file, we release
this documentation under the terms of the GFDL. this documentation under the terms of the GFDL.
The documentation is divided between two main sections :
- the kernel loader, in the `docs/loader` folder, which describes the technical This documentation is divided between two main sections :
features of the source code located under the `boot`
- The kernel loader, in the `docs/boot` folder, which describes the technical
features of the source code located under the `boot` folder.
- The kaleid code base, in the `docs/kaleid` folder, which describes the
source code of the kernel drivers, the kernel itself, the buffer library and the
C standard library, respectively located under the `kaleid/drivers`,
`kaleid/kernel`, `kaleid/libbuf`, `kaleid/libc` folders.
Under these directories, each file represents a source code subfolder. For
example : `docs/kaleid/kernel/io` file describes the `kaleid/kernel/io`
folder.