This is developer documentation for the Neutron bootloader, part of Project Atom. The wiki is organised into chapters, each with sub-chapters (pages) in Markdown format.

How to use the documentation

Start from the Chapters list below to find the topic you need. Each chapter has a short description; click through to see its sub-pages. Within each page, links point to related sections (e.g. build steps, memory map, kernel format) so you can follow the thread without jumping back to this index. If you are new to Neutron, begin with Introduction and Bootloader Layout and Design; if you want to build or run the project, go to Build Configuration. Kernel authors should head to Kernel Development Guide.

Chapters

  1. Introduction
    Project overview, goals, and supported platforms.

  2. Bootloader Layout and Design
    Memory map, boot sequence, components, and drivers.

  3. Build Configuration
    Building on Linux, macOS, and Windows (including Docker-based workflow).

  4. Kernel Development Guide
    Creating kernels that work with Neutron: NKRN format, boot info, and tooling.

We are open for contributions via issues for pointing out problems or feature requests and pull requests. Please read the contribution guidelines before contributing.