Browse Source

updated the README to represent the current state of the system

master
XeonSquared 6 months ago
parent
commit
2ce2692aee
1 changed files with 13 additions and 6 deletions
  1. +13
    -6
      README.md

+ 13
- 6
README.md View File

@@ -6,16 +6,25 @@ A lightweight, multi-user operating system for OpenComputers

### The kernel

The kernel can be built using luapreproc:
The kernel is composed of a number of modules, found in the *module/* directory. Which modules are included can be customised by changing the include statements in *module/init.lua*; copying it and customizing that is recommended, so you can *git pull* later without having to stash or reset your changes.

./luapreproc.lua module/init.lua kernel.lua
#### Unix-like systems

The kernel can be built using the preproc library and provided scripts:

lua build.lua module/init.lua kernel.lua

#### PsychOS

The kernel can be built from inside PsychOS using the preproc library, assuming you have the kernel source available:

preproc("module/init.lua","kernel.lua")

### The boot filesystem

A boot filesystem contains several things:

- The kernel, as init.lua
- The exec/ directory, as this contains all executables
- The lib/ directory, containing libraries
- The service/ directory, containing system services

@@ -23,6 +32,4 @@ This has been automated in the form of build.sh, pending a real makefile.

## Documentation

To generate function documentation, run:

./finddesc.lua module/* lib/* > apidoc.md
Documentation is generated as the system is built with build.sh; a set of markdown files will be placed into *doc/*, as well as an all-in-one *apidoc.md*. If pandoc is installed, an *apidoc.pdf* will also be generated.

Loading…
Cancel
Save