From 9b52fa97225125a94fbf3502c6d9910a6425291e Mon Sep 17 00:00:00 2001 From: nspackman Date: Mon, 10 Nov 2025 15:00:42 -0800 Subject: [PATCH] Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5639758..1ef576f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ -# nate-os +# NateOS – A Simple, Modular AArch64 Operating System + +## Overview + +NateOS is an open-source operating system designed to run on the Raspberry Pi 4 and other AArch64 platforms. It is built from scratch using C and Assembly language, focusing on simplicity, modularity, and ease of use. + +## Features + +- Simple, modular design for easy maintenance and extension +- Support for AArch64 architecture +- Basic kernel services: + - Serial console output + - Basic Display output +- User-space library for device drivers and system calls + +## Getting Started + +**Prerequisites:** +A Raspberry Pi. + +**Build NateOS:** +Clone the repository and run `make` in the project directory to build the kernel image (`kernel8.img`) and user-space libraries. + +**Install NateOS on your Raspberry Pi:** +Not Yet Tested + +**Test NateOS:** +Once booted, you should see a serial console prompt on the screen. You can interact with the operating system by typing commands. + +## Known Issues and Limitations +- Very Limited rendering +- Limited device driver support (UART only) +- No network stack implemented +- Debugging tools are minimal + +## Contributing to NateOS + +We welcome contributions from the community! If you'd like to help with development, please fork the repository and submit pull requests. Areas of interest include: + +- Implementing additional device drivers +- Improving debugging tools +- Expanding the user-space library + +## License + +NateOS is released under the AGPL-3.0 License. See `LICENSE.txt` for details. -an aarch64 operating system written in C to run on raspberry Pi SBC. \ No newline at end of file