canaryos/pelican
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Flesh out README

Browse source
This commit is contained in:
abbie 2023-07-08 20:40:27 +01:00
parent bdbb400807
commit a0e3d7508d
Signed by: threeoh6000
GPG key ID: 801FE4AD456E922C
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,3 +1,13 @@
# pelican
# Pelican
Open source boot loader and firmware for ComputerCraft.
Open source bootloader and pre-boot firmware for ComputerCraft.
## Dependencies and execution
Pelican expects to be ran under [FeatherBIOS](https://git.colean.cc/canaryos/feather) and as a result requires the following functions to be present on top of the bare ComputerCraft functions left over by UnBIOS:
* print() (and by extension write())
* read() (and by extension os.pullEvent())
* dofile() (and by extension loadfile() and a loadstring() and load() that act like Lua 5.2+)
FeatherBIOS generally loads into the bootloader/post-BIOS payload via `dofile(boot.lua)` and as a result, Pelican should be placed at `/boot.lua`.