diff --git a/README-zh-CN.md b/README-zh-CN.md new file mode 100644 index 0000000..f7bcf8a --- /dev/null +++ b/README-zh-CN.md @@ -0,0 +1,42 @@ +# CrashPowerDOS for x86 + +## 翻译 + +- [English](README.md) +- [中文](README-zh-CN.md) + +## 介绍 + +这是一个基于 x86 架构的简单操作系统。 + +## 构建并运行 + +### 环境 + +您需要安装这些软件: + +- Python 工具包 +- i686_elf_tools + +### 步骤 + +- 在终端上运行 `python build.py`,项目将开始构建 +- 运行 `grub-mkrescue -o cpos.iso isodir` 来打包 iso 文件 +- 运行 `qemu-system-i386 -cdrom cpos.iso` 就可以使用这个系统了! + +## 更新 + +- 重构内存管理。 + +## 许可协议 + +该项目完全遵循 MIT 协议,任何人都可以免费使用它,另见 [LICENSE](LICENSE)。 + +## 贡献 + +欢迎为这个项目提交 PR 或 issue,我会非常高兴看到它! + +### 贡献者们 + +* XIAOYI12 - xiaoyi1212 负责主要的OS开发 +* QtLittleXu - XuYuxuan 负责OS文档编写 diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f383e5 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# CrashPowerDOS for x86 + +## Translations + +- [English](README.md) +- [中文](README-zh-CN.md) + +## Introduction + +This is a simple operating system for x86 architecture. + +## Build & Run + +### Environment + +You need to install them on your computer: + +- Python toolkit +- i686_elf_tools + +### Steps + +- Run `python build.py` on your terminal then it is going to build +- Run `grub-mkrescue -o cpos.iso isodir` to package the iso file +- Run `qemu-system-i386 -cdrom cpos.iso` and you can use the system! + +## Update + +- Refactor the memory management. + +## License + +The project follows MIT license. Anyone can use it for free. See [LICENSE](LICENSE). + +## Contributing + +Welcome to create pull requests or issues to this project. I am really happy to see it! + +### Contributors + +* XIAOYI12 - xiaoyi12 OS Development +* QtLittleXu - XuYuxuan OS Document \ No newline at end of file