From d8003ed52d7e360995edd112bdd0b53af8eea9b5 Mon Sep 17 00:00:00 2001 From: Alexey Gavrilov Date: Tue, 9 Jun 2026 11:16:44 +0700 Subject: Root project documentation update `README.md` is rework. Describe project concept description and mention links. The old readme file build section move to the separate file `BUILD.md`. It helps to fast read the corresponding file instead of viewing a `README.md` table of content. 'CONTRIBUTING.md' file contents information to makes gain experience and contribute in project easier. 'CHANGELOG.md' provide a detailed, chronological history of change releases. Signed-off-by: Alexey Gavrilov --- BUILD.md | 73 +++++++++++++++++++++++++ CHANGELOG.md | 1 + CONTRIBUTING.md | 167 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 115 ++++++++++++++++++-------------------- 4 files changed, 293 insertions(+), 63 deletions(-) create mode 100644 BUILD.md create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..2e9c87d --- /dev/null +++ b/BUILD.md @@ -0,0 +1,73 @@ +## Requirements + +1. Compiler toolset chose in the toolchain file + * GCC cross compiler toolchain (arch-elf-tool - i686-elf-g++ for compiler) + + To build and install from source refer to the [documentation](https://gcc.gnu.org/install) + + * Clang cross compiler toolchain + Clang support cross compile out the box. + + You can download *clang* from your package manager. + + Using *apt*: + + ```bash + apt-get update && apt-get install clang + ``` + + Using *pacman*: + + ```bash + pacman -Sy clang + ``` + + Or build from source consider the [documentation](https://clang.llvm.org/get_started.html) + +2. Nasm compiler (for x86 only) + + To download from package manager. + + Using *apt* + + ```bash + apt-get update && apt-get install nasm + ``` + + Using *pacman* + + ```bash + pacman -Sy nasm + ``` + +3. Grub bootloader (only it is currently supported) + + It is reccommended to build grub from source configured target as chose +architecture. + + To build grub from source refer to the [documentation](https://www.gnu.org/software/grub/manual/grub/html_node/Obtaining-and-Building-GRUB.html) + +## Kernel configuration +You can configure kernel using cmake -D option. All cmake options build-in are supported + +### Options +Not yet available options + +## Build instructions + +### On your host environment +``` +cmake -DCMAKE_TOOLCHAIN_FILE= -D