Operating system for OpenComputers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Izaya 124b39c96d Merge pull request 'Fix document generation on Windows (using Git Bash)' (#3) from Skye/OC-PsychOS2:git-windows-bash-fixes into master 5 months ago
cfg default rc configuration 7 months ago
lib added type annotations and descriptions for functions where appropriate 5 months ago
module added type annotations and descriptions for functions where appropriate 5 months ago
service updated termsrv to basically work with the new rc system, added nc to netutil 6 months ago
.gitignore updated finddesc to use the new doc library, allowing type annotations and building a directory of documentation 5 months ago
LICENSE Initial commit 2 years ago
README.md updated the build instructions, script and gitignore 1 year ago
build.sh Fix document generation on Windows (using Git Bash) 5 months ago
docs-metadata.yml added a title for PDF generation 5 months ago
finddesc.lua Fix document generation on Windows (using Git Bash) 5 months ago
gendoc.lua added doc() support for pre-compiled API documentation, wrote a generator for it, and included that in the build script 5 months ago
luapreproc.lua added type annotations and descriptions for functions where appropriate 5 months ago
package.sh added minitel to the default init, updated the package script 11 months ago
template.tex updated finddesc to use the new doc library, allowing type annotations and building a directory of documentation 5 months ago

README.md

OC-PsychOS2

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.

Documentation

To generate function documentation, run:

./finddesc.lua module/* lib/* > apidoc.md