How to Install

How to Install KryonOS

There are two primary ways to install KryonOS onto your ESP32: using precompiled binaries (easiest) or building it from the source code.

Option 1: Using Precompiled Binaries (Recommended)

You don't need to set up a complex C++ build environment. You can flash KryonOS directly using an ESP flasher tool.

1. Download the Binaries

Go to the Releases Page and download the 3 required .bin files from the latest release:

1. bootloader.bin
2. partitions.bin
3. firmware.bin

2. Flash the Firmware

Connect your ESP32 via USB. Use a tool like esptool.py or the official ESP Flash Download Tool. Ensure you write to the correct memory addresses!

esptool.py --chip esp32 --port COM3 --baud 921600 write_flash -z \
  0x1000 bootloader.bin \
  0x8000 partitions.bin \
  0x10000 firmware.bin

(Make sure to change COM3 to your actual serial port!)

---

Option 2: Build it Yourself (PlatformIO)

If you want to modify the C++ core or compile the OS for a custom pinout, you'll need to build it from source.

1. Prerequisites: Install Visual Studio Code and the PlatformIO IDE extension.
2. Download Source: Clone the repository or download the ZIP file.
3. Open Project: Open the KryonOS folder in VS Code. PlatformIO will automatically install required libraries (like TFT_eSPI and ArduinoJson).
4. Compile and Upload: Connect your ESP32 and click the Upload button in PlatformIO, or run the following command in the terminal:

pio run -t upload

Note: The first compilation might take a few minutes as it downloads dependencies.