Update README.md

This commit is contained in:
2025-11-10 15:00:42 -08:00
parent bbfd31b5fd
commit 9b52fa9722

View File

@@ -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.