rustkernel/README.md
ale 7409cd4d26
initial commit
Signed-off-by: ale <ale@manalejandro.com>
2025-06-15 22:26:49 +02:00

51 lines
1.2 KiB
Markdown

# Rust Kernel
A Rust-based kernel inspired by the Linux kernel, utilizing the Rust for Linux infrastructure.
## Overview
This project aims to create a modern kernel implementation in Rust, leveraging memory safety and performance benefits while maintaining compatibility with Linux kernel concepts and APIs.
## Architecture
- **kernel/**: Core kernel functionality and APIs
- **drivers/**: Device drivers written in Rust
- **modules/**: Loadable kernel modules
- **arch/**: Architecture-specific code
- **mm/**: Memory management
- **fs/**: File system implementations
- **net/**: Network stack
- **security/**: Security subsystem
## Building
```bash
# Build the kernel
cargo build --release
# Run tests
cargo test
# Check code formatting
cargo fmt --check
# Run clippy lints
cargo clippy -- -D warnings
```
## Features
- Memory-safe kernel implementation
- Zero-cost abstractions
- Modern async/await support for I/O operations
- Modular architecture
- Linux-compatible APIs where possible
## License
This project is licensed under GPL-2.0, following the Linux kernel license.
## Contributing
Contributions are welcome! Please follow the Linux kernel coding style and Rust conventions.