From bf3b37783fb2fcb3016e20eaee59aab47a69204e Mon Sep 17 00:00:00 2001 From: sawyer bristol Date: Fri, 26 Sep 2025 22:51:35 -0600 Subject: [PATCH] Readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad9c6b6 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# PicoCalc OS (Rust) + +A simple operating system for the **Clockwork PicoCalc**, written in Rust. +This project provides a minimal kernel, ABI, and user-space applications to experiment with OS development on constrained hardware. + +## Project Structure + +- **`kernel/`** – The core OS kernel (task scheduling, drivers, memory, etc.) +- **`abi/`** – Shared application binary interface definitions for kernel ↔ userspace interaction +- **`abi_sys/`** – System-level ABI helpers +- **`shared/`** – Shared utilities and common code across kernel and user applications +- **`user-apps/`** – Collection of userspace programs (calculator, snake, etc.) + +## Features + +- Minimal Rust-based kernel targeting the PicoCalc +- Custom ABI for safe communication between kernel and applications +- Support for multiple user-space applications +- Hardware drivers tailored for the PicoCalc + +## Getting Started + +```bash +git clone https://github.com/LegitCamper/picocalc-os-rs.git +cd picocalc-os-rs +just calculator +# copy the calculator to the sdcard and rename it to calculator.bin +just kernel