Get started in a minute

Clone, build the x86 development example, then run on hardware.

  1. Clone the repository

    git clone https://github.com/SuperTinyKernel-RTOS/stk

  2. Try it on your PC

    STK has an x86 development mode, so you can build and run examples without hardware. See the Quick Start in the README for the exact commands.

  3. Add STK to your project

    Use Git and CMake, copy the files manually, or sparse-clone only the kernel:

    git clone --depth 1 --filter=blob:none --no-checkout https://github.com/SuperTinyKernel-RTOS/stk.git
cd stk
git sparse-checkout init --cone
git sparse-checkout set stk
git checkout

  4. Port or extend

    Platform code lives in stk/src/arch and stk/include/arch. Ready examples exist for STM32 and Raspberry Pi Pico 2 W (including TrustZone).

  5. Read the API docs

    Browse the Doxygen reference.