pelican/README.md

14 lines
643 B
Markdown
Raw Normal View History

2023-07-08 20:40:27 +01:00
# Pelican
2023-07-08 17:57:49 +01:00
2023-07-08 20:40:27 +01:00
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`.