Operating system for OpenComputers
Go to file
Skye M 56af6d1ade Fix document generation on Windows (using Git Bash)
* Made finddesc.lua execute commands using `sh -c 'command'`, which ensures that Unix-like shell is used instead of cmd.exe
* Made finddesc.lua avoid a situation where it would end up with a double '/' in `outpath`
* Redirect output of deleting the document to null to avoid pointless "No such file or directory" errors.
2020-05-12 16:29:44 +01:00
cfg default rc configuration 2020-03-20 13:15:20 +11:00
lib added type annotations and descriptions for functions where appropriate 2020-05-12 17:55:05 +10:00
module added type annotations and descriptions for functions where appropriate 2020-05-12 17:55:05 +10:00
service updated termsrv to basically work with the new rc system, added nc to netutil 2020-04-15 13:33:27 +10:00
.gitignore updated finddesc to use the new doc library, allowing type annotations and building a directory of documentation 2020-05-12 12:01:44 +10:00
LICENSE Initial commit 2018-09-30 10:12:29 +10:00
README.md updated the build instructions, script and gitignore 2019-11-05 14:06:19 +11:00
build.sh Fix document generation on Windows (using Git Bash) 2020-05-12 16:29:44 +01:00
docs-metadata.yml added a title for PDF generation 2020-05-12 16:11:51 +10:00
finddesc.lua Fix document generation on Windows (using Git Bash) 2020-05-12 16:29:44 +01:00
gendoc.lua added doc() support for pre-compiled API documentation, wrote a generator for it, and included that in the build script 2020-05-12 16:59:17 +10:00
luapreproc.lua added type annotations and descriptions for functions where appropriate 2020-05-12 17:55:05 +10:00
package.sh added minitel to the default init, updated the package script 2019-11-20 08:30:38 +11:00
template.tex updated finddesc to use the new doc library, allowing type annotations and building a directory of documentation 2020-05-12 12:01:44 +10:00

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