From f2f991b2392f314100c4bb8a8a94ea2a8878028e Mon Sep 17 00:00:00 2001 From: "Tate, Hongliang Tian" Date: Thu, 15 Feb 2024 16:47:10 +0800 Subject: [PATCH] Add the Chinese version README --- README.md | 4 +- README_CN.md | 71 +++++++++++++++++++ docs/src/images/logo_cn.svg | 136 ++++++++++++++++++++++++++++++++++++ tools/bump_version.sh | 1 + 4 files changed, 211 insertions(+), 1 deletion(-) create mode 100644 README_CN.md create mode 100644 docs/src/images/logo_cn.svg diff --git a/README.md b/README.md index b1b25ceeb..03059d1f2 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,11 @@ A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux

+English | [中文版](README_CN.md) + ## Introducing Asterinas -Asterinas (星绽 in Chinese) is a _secure_, _fast_, and _general-purpose_ OS kernel +Asterinas is a _secure_, _fast_, and _general-purpose_ OS kernel that provides _Linux-compatible_ ABI. It can serve as a seamless replacement for Linux while enhancing _memory safety_ and _developer friendliness_. diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 000000000..01054adaf --- /dev/null +++ b/README_CN.md @@ -0,0 +1,71 @@ +

+ asterinas-logo
+ 一个安全、快速、通用的操作系统内核，使用Rust编写，并与Linux兼容 +

+ +[English](README.md) | 中文版 + +## 初见星绽 + +星绽（英文名：Asterinas）是一个*安全*、*快速*、*通用*的操作系统内核。 +它提供于Linux相同的ABI，可无缝运行Linux应用， +但比Linux更加*内存安全*和*开发者友好*。 + +* 星绽在内存安全性方面远胜Linux。 +它使用Rust作为唯一的编程语言， +并将*unsafe Rust*的使用限制在一个明确定义且最小的可信计算基础（TCB）上。 +这种新颖的方法， +被称为[框内核架构](https://asterinas.github.io/book/kernel/the-framekernel-architecture.html)， +使星绽成为一个更安全、更可靠的内核选择。 + +* 星绽在开发者友好性方面优于Linux。 +它赋能内核开发者们 +（1）使用生产力更高的Rust编程语言， +（2）利用一个专为内核开发者设计的工具包（称为[OSDK]()）来简化他们的工作流程， +（3）享受[MPL](#License)所带来的灵活性， +可自由选择开源或闭源他们为星绽所开发的内核模块或驱动。 + +虽然通往生产级操作系统内核的路上注定充满艰险， +但我们坚信正朝着正确的方向迈进。 +当前，星绽仅支持x86-64虚拟机； +[我们2024年的目标](https://asterinas.github.io/book/kernel/roadmap.html)是 +使星绽在x86-64虚拟机环境中达到生产可用。 + +## 快速上手 + +准备一台安装了Docker的、x86-64架构的Linux机器。 +按照以下三个简单的步骤来构建和启动星绽。 + +1. 下载最新的源代码。 + +```bash +git clone https://github.com/asterinas/asterinas +``` + +2. 运行一个作为开发环境的Docker容器。 + +```bash +docker run -it --privileged --network=host --device=/dev/kvm -v ./asterinas:/root/asterinas asterinas/asterinas:0.3.0 +``` + +3. 在容器内，进入项目文件夹构建并运行星绽。 + +```bash +make build +make run +``` + +如果一切顺利，星绽现在应该在一个虚拟机内运行起来了。 + +## 技术文档 + +查看[The Asterinas Book](https://asterinas.github.io/book/) +以了解更多关于本项目的信息。 + +## 开源许可 + +星绽的源代码和文档主要使用 +[Mozilla公共许可证（MPL），版本2.0](https://github.com/asterinas/asterinas/blob/main/LICENSE-MPL)， +部分组件在更宽松的许可证下发布， +详见[这里](https://github.com/asterinas/asterinas/blob/main/.licenserc.yaml)。 +关于选择MPL的原因，请见[这里](https://asterinas.github.io/book/index.html#licensing)。 diff --git a/docs/src/images/logo_cn.svg b/docs/src/images/logo_cn.svg new file mode 100644 index 000000000..eb838ed34 --- /dev/null +++ b/docs/src/images/logo_cn.svg @@ -0,0 +1,136 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/tools/bump_version.sh b/tools/bump_version.sh index 23dc6af72..7118ad745 100755 --- a/tools/bump_version.sh +++ b/tools/bump_version.sh @@ -38,6 +38,7 @@ cargo update -p asterinas --precise $new_version # Update Docker image versions in README files update_image_versions ${ASTER_SRC_DIR}/README.md +update_image_versions ${ASTER_SRC_DIR}/README_CN.md update_image_versions ${SCRIPT_DIR}/docker/README.md # Update Docker image versions in workflows