A minimal Real-Time Operating System (RTOS) designed for embedded applications with targets for x86_64, RISC-V (RV32I, RV64I) and ARM written in Zig.

Before attempting to build this project, make sure you have Zig and Nix installed on your machine.

To get a local copy of the project up and running on your machine, follow these simple steps:

1. Clone the project repository

   git clone https://github.com/Kaweees/kiwiRTOS.git
   cd kiwiRTOS

2. Install the project dependencies

   nix-shell --max-jobs $(nproc) # Linux / Windows (WSL)
   nix-shell --max-jobs $(sysctl -n hw.ncpu) # macOS

3. Run the project

   just run <architecture>

.kiwiRTOS/
├── .github/                       - GitHub Actions CI/CD workflows
├── build.zig                      - Zig build file
├── src/                           - Project packages
│   ├── arch/                      - Architecture specific code
│   │   ├── x86_64/                  - x86_64 architecture specific code
│   │   ├── riscv/                   - RISC-V architecture specific code
│   │   └── arm/                     - ARM architecture specific code
│   ├── drivers/                   - Device drivers
│   ├── kernel/                    - Kernel code
│   ├── lib/                       - Library code
│   └── tests/                     - Project tests
├── LICENSE                        - Project license
└── README.md                      - You are here

The source code for this project is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See LICENSE for details and more information.