From: Svjatoslav Agejenko Date: Sat, 14 Feb 2026 14:37:48 +0000 (+0200) Subject: Migrated documentation from `AGENTS.md` to `AGENTS.org` using Emacs org-mode syntax... X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=commitdiff_plain;h=7b037bd78ad41fd37a137e0629093a17a8e5a482;p=fifth.git Migrated documentation from `AGENTS.md` to `AGENTS.org` using Emacs org-mode syntax for better structuring and readability. --- diff --git a/AGENTS.md b/AGENTS.md deleted file mode 100644 index e69de29..0000000 diff --git a/AGENTS.org b/AGENTS.org new file mode 100644 index 0000000..937b5fe --- /dev/null +++ b/AGENTS.org @@ -0,0 +1,64 @@ +- Primary documentation is stored in *.org files (they use emacs + org-mode syntax). All html files are compiled from org, so you + better read and write org files instead of html. + +* Components +** Kernel + +Kernel is minimal viable implementation of fifth language compiler and +interpreter. It is immediately loaded when virtual machine starts. + +- *kernel/core.asm*: Main kernel code in virtual CPU own Assempbly + language. +- *kernel/define.inc*: Machine code definitions for the virtual CPU + instructions. + +** Emulator + +The virtual CPU emulator. + +- *emulator/emulator.asm*: Main emulator code that interprets Fifth + machine code and interfaces with host system resources. + +** Drivers + +Hardware interface components that handle input and output devices. + +- *imageFile/f/lib/5TH_DRVKBD*: Keyboard driver that translates scan + codes into Fifth's character encoding (FSCII). +- *imageFile/f/lib/5TH_DRVMOUSE*: Mouse driver that tracks cursor + position and button states for graphical interaction. + +** Graphics Libraries + +Components responsible for rendering visual elements. + +- *imageFile/f/lib/5th_gfx*: Basic 2D graphics functions including + drawing lines, boxes, and image manipulation. +- *imageFile/f/lib/5th_gfx2*: Advanced graphics routines for more + complex rendering operations. + +** Utility Libraries + +Specialized mathematical and data processing functions. + +- *imageFile/f/lib/5th_trig*: Trigonometric functions (sin, cos). + +** Tools +Utilities for development and maintenance of the Fifth system. + +- *tools/5th2src.bas*: Converts system files (FSCII encoded) into + human-readable source code format. +- *tools/fsimport.bas*: Imports external files into the Fifth system's + virtual disk image. +- *tools/src25th.bas*: Converts source code back into system-compatible + FSCII encoded files. + +** Documentation + +System reference materials. + +- *doc/index.org*: Main documentation page providing an overview of + the Fifth system. +- *doc/language.org*: Detailed reference for the Fifth programming + language syntax and commands.