diff --git a/sdk/cmake/README.md b/sdk/cmake/README.md new file mode 100644 index 0000000..137ac6a --- /dev/null +++ b/sdk/cmake/README.md @@ -0,0 +1,4 @@ +## Cmake Build System +This directory contains a set of .cmake files that provide the necessary configuration and functionality for the build +process. These files provide the necessary toolchain configuration, additional functions for the build system, and QEMU +configuration for testing the XT Operating System. diff --git a/sdk/ovmf/README.md b/sdk/ovmf/README.md new file mode 100644 index 0000000..b719bd5 --- /dev/null +++ b/sdk/ovmf/README.md @@ -0,0 +1,12 @@ +## Open Virtual Machine Firmware (OVMF) +This directory contains the essential components of the Open Virtual Machine Firmware (OVMF), which provides +an open-source implementation of the Unified Extensible Firmware Interface (UEFI) for virtual machines. + +The ovmf_code files contain the CPU architecture specific UEFI firmware code, which serves as the initial boot code +for virtual machines used to test the XTOS. It includes the necessary instructions and functions to initialize hardware, +load the operating system, and provide various system services during the boot process. The ovmf_code file is +responsible for establishing a UEFI environment within the virtual machine, enabling it to boot and operate effectively. + +The ovmf_vars files, store UEFI variables, which are used to store and retrieve system configuration information, such as +boot options, device settings, and system preferences. The ovmf_vars file contains the persistent variables specific to +a virtual machine, allowing it to maintain its configuration across multiple boot sessions. diff --git a/xtldr/README.md b/xtldr/README.md new file mode 100644 index 0000000..3d0b51b --- /dev/null +++ b/xtldr/README.md @@ -0,0 +1,14 @@ +## XT Loader (XTLDR) +The XTLDR, or XTOS Boot Loader, is an EFI (Extensible Firmware Interface) boot loader specifically designed for XTOS. +As an EFI boot loader, XTLDR operates exclusively with EFI-based hardware and is not compatible with non-EFI systems, +like old and deprecated BIOS. + +One of the notable features of XTLDR is its modular design. The boot loader is divided into different modules, with only +the essential core being loaded during the boot process. This modular approach allows for a more efficient and +streamlined boot experience, as only the necessary functionality is loaded, reducing the boot time and system resource +usage. + +XTLDR includes various modules that provide specific functionalities required for the boot process. For example, there is +a module dedicated to supporting the XTOS boot protocol, which is the specific protocol used by XTOS for loading and +executing the OS kernel. Additionally, there is a module for handling PE/COFF (Portable Executable) binaries, which is +a commonly used format of executable files used by the XTOS.