2020-02-20 21:16:17 +01:00
|
|
|
#=----------------------------------------------------------------------------=#
|
2020-09-27 17:33:48 +02:00
|
|
|
# OS on Kaleid Documentation #
|
2020-02-20 21:16:17 +01:00
|
|
|
# #
|
|
|
|
|
# Desc: Summary and some description #
|
|
|
|
|
# #
|
2020-02-20 21:50:22 +01:00
|
|
|
# #
|
|
|
|
|
# Copyright © 2018-2020 The OS/K Team #
|
|
|
|
|
# #
|
2020-02-20 21:16:17 +01:00
|
|
|
# Permission is granted to copy, distribute and/or modify this #
|
|
|
|
|
# document under the terms of the GNU Free Documentation License, #
|
|
|
|
|
# Version 1.3 or any later version published by the Free Software #
|
|
|
|
|
# Foundation; with no Invariant Sections, no Front-Cover Texts, and #
|
|
|
|
|
# no Back-Cover Texts. A copy of the license is included in the #
|
|
|
|
|
# file entitled "COPYING.GFDL" #
|
|
|
|
|
#=----------------------------------------------------------------------------=#
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This `docs` folder is the root of the OS/K (OS on Kaleid) technical
|
|
|
|
|
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
|
|
|
|
|
this documentation under the terms of the GFDL.
|
|
|
|
|
|
2020-02-20 21:50:22 +01:00
|
|
|
|
|
|
|
|
This documentation is divided between two main sections :
|
|
|
|
|
|
2020-02-20 22:10:03 +01:00
|
|
|
- The kernel loader, in the `docs/boot` folder, which describes the
|
|
|
|
|
technical features of the source code located under the `boot` folder.
|
2020-02-20 21:50:22 +01:00
|
|
|
|
|
|
|
|
- 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.
|
|
|
|
|
|
2020-02-20 22:10:03 +01:00
|
|
|
Under these directories, each file represents a terminal source code
|
|
|
|
|
subfolder. For example : `docs/kaleid/kernel/io` file describes the
|
|
|
|
|
`kaleid/kernel/io` folder that contains C source files.
|
|
|
|
|
|
|
|
|
|
If a non terminal subfolder is to be described, a description file can be
|
|
|
|
|
created by creating a file with the name of the folder, followed by a ".desc"
|
|
|
|
|
extension, inside this folder.
|
