README documentation

This commit is contained in:
deadvey
2026-02-23 21:37:26 +00:00
parent 249e02efe3
commit 7eea8d0ce1

View File

@@ -12,6 +12,13 @@ more about kernels and low level system functionality.<br/>
In order to help with comprehension, there are a lot<br/> In order to help with comprehension, there are a lot<br/>
of inline comments descibing what each part does. of inline comments descibing what each part does.
# Commands
- CAT <filename>: outputs the contents of the file.
- LS: outputs a list of files on the system .
- CLEAR: clears the screen.
- REBOOT: reboots the system, this can also be done with [esc].
- BAS <filename>: runs a basic script.
# Running it # Running it
In order to build this project on a Linux system run<br/> In order to build this project on a Linux system run<br/>
the following commands. the following commands.
@@ -38,3 +45,10 @@ boot the virtual machine (QEMU) for testing purposes.<br/>
``` ```
This will dump the contents of memory in /dev/shm/qemu-ram<br/> This will dump the contents of memory in /dev/shm/qemu-ram<br/>
To allow for easier debugging. To allow for easier debugging.
# BASIC development
Please refer to the [MikeOS BASIC documentation](https://mikeos.sourceforge.net/handbook-appdev-basic.html)<br/>
docs on writing BASIC code. In order to create new<br/>
files, place them in the /data/ directory, not the file<br/>
names are limited to 11 characters due to FAT12 limitations<br/>
(8 for the name and 3 for the extension).