OC-PsychOS2/README.md

29 lines
631 B
Markdown
Raw Permalink Normal View History

2018-09-30 10:12:29 +10:00
# OC-PsychOS2
2019-01-08 22:13:52 +11:00
A lightweight, multi-user operating system for OpenComputers
## Building
### The kernel
The kernel can be built using luapreproc:
./luapreproc.lua 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
This has been automated in the form of build.sh, pending a real makefile.
2019-01-08 22:13:52 +11:00
## Documentation
To generate function documentation, run:
./finddesc.lua module/* lib/* > apidoc.md