Browse Source

updated the build instructions, script and gitignore

master
XeonSquared 1 week ago
parent
commit
9358f60401
3 changed files with 25 additions and 9 deletions
  1. 1
    2
      .gitignore
  2. 19
    0
      README.md
  3. 5
    7
      build.sh

+ 1
- 2
.gitignore View File

@@ -1,6 +1,5 @@
/build
apidoc.md
apidoc.html
psychos/
*.cpio
*.af
/target

+ 19
- 0
README.md View File

@@ -2,6 +2,25 @@

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:

+ 5
- 7
build.sh View File

@@ -1,7 +1,5 @@
#!/usr/bin/env bash
mkdir build
cd module
cat sched.lua syslog.lua vt100.lua fs.lua iofs.lua loadfile.lua vt-task.lua io.lua dispmanager.lua init.lua > ../build/psychos.lua
cd ..
echo '_OSVERSION="PsychOS 2.0a0"' >> build/*
echo sched\(\) >> build/*
#!/bin/sh
rm -r target/*
mkdir target
lua luapreproc.lua module/init.lua target/init.lua
cp -r exec/ service/ lib/ target/

Loading…
Cancel
Save