izaya/OC-PsychOS2
1
1
Fork 0
mirror of https://git.shadowkat.net/izaya/OC-PsychOS2.git synced 2024-12-25 12:15:26 -05:00
Code Issues Releases Wiki Activity
Operating system for OpenComputers
276 Commits 1 Branch 0 Tags 649 KiB
Lua 98.2%
TeX 1.1%
Shell 0.7%
7849fca4a0
Go to file
XeonSquared 7849fca4a0 stamp the kernel variant onto the version string
2023-08-01 20:44:14 +10:00
cfg and another one. oops. 2023-08-01 15:58:16 +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 turns out this was already packaged. whoops. 2023-08-01 18:26:14 +10:00
module add module for booting from rtfs volumes 2023-08-01 18:02:14 +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 refactor build system to allow pulling libraries from packages, assuming directories are set up correctly 2023-08-01 17:58:27 +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 refactor build system to allow pulling libraries from packages, assuming directories are set up correctly 2023-08-01 17:58:27 +10:00
README.md updated the README to represent the current state of the system 2020-06-05 23:06:37 +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. 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.