sam/OC-PsychOS2
1
0
Fork 0
forked from izaya/OC-PsychOS2
Code Issues Pull Requests Releases Wiki Activity
Operating system for OpenComputers
287 Commits 1 Branch 0 Tags 442 KiB
Lua 97.7%
TeX 1.3%
Shell 1%
82decfabf9
Go to file
XeonSquared 82decfabf9 pkgman updates to simplify distribution with different kernels
2023-08-05 16:22:59 +10:00
kcfg refactor build system to allow pulling libraries from packages, assuming directories are set up correctly 2023-08-01 17:58:27 +10:00
lib pkgman updates to simplify distribution with different kernels 2023-08-05 16:22:59 +10:00
module fix support for booting from rtfs on tape 2023-08-05 10:06:05 +10:00
service moved fserv to its own package 2023-08-01 18:21:08 +10:00
.editorconfig clipboard: Make the clipboard service work under the new service sys 2020-05-21 15:02:46 -04:00
.gitignore clipboard: Make the clipboard service work under the new service sys 2020-05-21 15:02:46 -04:00
build.lua add some simple minification filters to preproc, which can shrink the kernel significantly 2023-08-04 20:32:42 +10:00
build.sh stamp the kernel variant onto the version string 2023-08-01 20:44:14 +10: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
LICENSE Initial commit 2018-09-30 10:12:29 +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
preproc.lua add some simple minification filters to preproc, which can shrink the kernel significantly 2023-08-04 20:32:42 +10:00
README.md update to match latest diskpart 2023-08-03 12:15:03 +10: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 is composed of a number of modules, found in the module/ directory, as specified by a file in the kcfg directory, base by default. Which modules are included can be customised by changing the include statements in the kernel configuration file; 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 kcfg/base.cfg kernel.lua

PsychOS

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

preproc("kcfg/base.cfg","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
  • The exec/ directory, containing single-shot executable files

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.