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 4e64a55169 cleaner default source list 2 years ago
cfg cleaner default source list 2 years ago
lib cleaner default source list 2 years ago
module made require search the pkgfs if available 2 years ago
service remove vcomponent and vtunnel because they are now included in the PsychOSPackages repo 2 years ago
.editorconfig clipboard: Make the clipboard service work under the new service sys 2 years ago
.gitignore clipboard: Make the clipboard service work under the new service sys 2 years ago
LICENSE Initial commit 4 years ago
README.md updated the README to represent the current state of the system 2 years ago
build.lua added the preproc library, meaning PsychOS is nominally self-hosting 2 years ago
build.sh bumped the version number because we selfhosting now 2 years ago
docs-metadata.yml added a title for PDF generation 2 years ago
finddesc.lua Fix document generation on Windows (using Git Bash) 2 years ago
gendoc.lua added doc() support for pre-compiled API documentation, wrote a generator for it, and included that in the build script 2 years ago
luapreproc.lua added type annotations and descriptions for functions where appropriate 2 years ago
package.sh added minitel to the default init, updated the package script 3 years ago
preproc.lua move actual preproc lib into folder rather than symlinking to the version in lib/, a better solution will be considered later 2 years ago
template.tex updated finddesc to use the new doc library, allowing type annotations and building a directory of documentation 2 years ago

README.md

OC-PsychOS2

A lightweight, multi-user operating system for OpenComputers

Building

The kernel

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.

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 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

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.