Files
meta-unit-core/README.md
李东云 00e8d4811c init:完善项目文档并设置开发环境
- 新增贡献指南、开发指南和README的中文版本
- 创建Dev Container配置文件,包括Dockerfile、docker-compose.yml和devcontainer.json
- 初始化项目结构,创建必要的目录和文件
- 设置Rust开发环境,包括依赖和工具链
2025-06-05 13:59:19 +08:00

46 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# meta-unit-core
[中文](README-CN.md)
**The Foundational Microkernel for Dao Operating System.**
---
## Overview
`meta-unit-core` is the heart of the [Dao Operating System Project](https://nest.doylee.cn/dao-os) a novel, decentralized, and polyglot OS overlay for the emerging era of CyberLife. It's designed to provide a robust, secure, and extensible computing environment, focusing on efficient, multi-language interoperability powered by WebAssembly (WASM) and Protobuf.
As a microkernel, `meta-unit-core` provides the essential primitives for resource management, inter-process communication (IPC), and secure execution of services and Avatars (CyberLife entities). Its modular architecture allows for the dynamic loading and unloading of service modules, fostering a flexible and resilient system.
## Key Features
* **Microkernel Architecture:** Minimal core for maximum security and stability.
* **WASM-Native Execution:** Services and Avatars run as WASM modules, enabling polyglot development (Rust, C/C++, Go, etc.).
* **Protobuf-Driven IPC:** All communication within the system and with the Avatar Host is standardized via Protobuf messages, ensuring type safety and forward compatibility.
* **Extensible Service Model:** A pluggable architecture for core services (Identity, Filesystem, P2P, Communication, etc.) and future third-party modules.
* **Trunk-Based Development (TBD):** Rapid iteration and continuous integration are central to our development workflow.
## Getting Started
To set up your development environment and start contributing to `meta-unit-core`, please refer to our [Development Guide](GUIDE.md).
## Project Structure
```
meta-unit-core/
├── .devcontainer/ # Dev Container configuration (Dockerfile, docker-compose.yml, devcontainer.json)
├── src/ # Core Rust source code for the microkernel
├── tests/ # Unit and integration tests
├── benches/ # Benchmarks
├── examples/ # Example WASM service modules or Avatars
├── Cargo.toml # Rust project manifest
└── LICENSE # Project license (Apache License 2.0)
```
## Contributing
We welcome contributions from the community! Please refer to our [Contributing Guidelines](CONTRIBUTING.md) (coming soon) for details on how to get involved, report issues, and submit pull requests. We follow a Trunk-Based Development (TBD) workflow.
## License
`meta-unit-core` is licensed under the **Apache License 2.0**. See the [LICENSE](LICENSE) file for more details.
---