pelican/README.md

# Pelican

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()`)

FeatherBIOS generally loads into the bootloader/post-BIOS payload via `dofile(boot.lua)` and as a result, Pelican should be placed at `/boot.lua`.