Skip to content

Latest commit

 

History

History
28 lines (26 loc) · 1.56 KB

PORTING.md

File metadata and controls

28 lines (26 loc) · 1.56 KB

Porting Beryllium OS

These instructions are seperated into 3 big steps:

  1. Verify your board will actually be able to run it.
    gc.mem_free() should be at least 100000 for the kernel to be able to function.
    Your board should have at least one serial port, or wifi.

  2. From within "Boardfiles", copy and modify a similar board's folder.
    For the settings.toml, you need to edit the led to match the respective pin for your board, and set the type.
    The supported types are "neopixel", "neopixel_invert", "generic", "generic_invert", "rgb" and "rgb_invert".
    "generic" is any simple on / off led.
    "neopixel" is for neopixel leds.
    "rgb" is for tri-color leds.

    For the pinout.map, you need to create a ascii pinout for the board.
    If you feel too uncreative, you can skip it.

    For packages.txt you need to include all the packages this board needs.
    You are advised to view similar boards's packages.txt

    For drivers.txt just like packages, include what is needed for all the board to work fully out of the box.
    If something you want doesn't exist, you may make it, or skip it.

    For both packages.txt and drivers.txt you should only have one item per line, followed by no spaces or comments.

  3. Test your changes by loading beryllium onto the board.
    Ensure the status led works, and the statuses are not inverted and that all the needed packages are preinstalled.