From e79c3c6aef7a5a8e8f6c17aead94e91a55c468f6 Mon Sep 17 00:00:00 2001 From: Jaby Date: Wed, 8 Feb 2023 19:51:07 +0100 Subject: [PATCH] Starting documentation --- docs/Features/auto_lba.md | 34 ++++++++++++++++++++++++++++++++++ docs/docs.md | 8 +++++++- 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/Features/auto_lba.md diff --git a/docs/Features/auto_lba.md b/docs/Features/auto_lba.md new file mode 100644 index 00000000..9aaa6406 --- /dev/null +++ b/docs/Features/auto_lba.md @@ -0,0 +1,34 @@ +# Auto LBA + +## Table of Contents +- [In Code](#in-code) + - [Overlay](#overlay) + - [Main file](#main-file) +- [For CD generation](#for-cd-generation) + +To support the `Auto LBA` feature changes need to be applied to the source files and the CD configuration file. The changes for the source files depend on if they are an Overlay or part of the main executable. + +--- + +## In Code +To use the `Auto LBA` feature the LBAs first need to be defined in either an `enum` or `enum struct`. These need to fit a special pattern. + +`__jabyengine_start_lba_request` needs to be the first entry while `__jabyengine_end_lba_request` needs to be the last. Each LBA entry needs to be declared with `__jabyengine_request_lba_for` followed by the name for the enum entry and the file path on the disk. + +```c++ +#include + +enum LBA { + __jabyengine_start_lba_request + __jabyengine_request_lba_for(SYSTEM_CNF, "SYSTEM.CNF"), + __jabyengine_end_lba_request +}; +``` + +### __Overlay__ +More Text + +### __Main file__ +Text + +## For CD generation \ No newline at end of file diff --git a/docs/docs.md b/docs/docs.md index c915e871..477c614a 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -1 +1,7 @@ -# Hello Docu \ No newline at end of file +# JabyEngine Documentation + +## Table of Contents +- [Features](#features) +--- +## Features +- [Auto LBAs](./Features/auto_lba.md) \ No newline at end of file