Browse Source

doc: 完善README.md (#849)

* doc: 完善README.md
LoGin 7 months ago
parent
commit
9a4832f8bc
2 changed files with 41 additions and 115 deletions
  1. 20 56
      README.md
  2. 21 59
      README_EN.md

+ 20 - 56
README.md

@@ -26,25 +26,25 @@
   DragonOS目前在社区驱动下正在快速发展中,目前DragonOS已经实现了约1/4的Linux接口,在未来我们将提供对Linux的100%兼容性,并且提供新特性。
   DragonOS目前在社区驱动下正在快速发展中,目前DragonOS已经实现了约1/4的Linux接口,在未来我们将提供对Linux的100%兼容性,并且提供新特性。
 
 
 
 
-[关于DragonOS,你想了解的都在这儿 - DragonOS](https://dragonos.org/?p=46)
+## 参与开发?
 
 
-## 网站
+仔细阅读 [DragonOS社区介绍文档] ,能够帮助你了解社区的运作方式,以及如何参与贡献!
 
 
-- 项目官网  **[DragonOS.org](https://dragonos.org)**
+- **了解开发动态、开发任务,请访问DragonOS社区论坛**: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
+- 您也可以从项目的issue里面了解相关的开发内容。
 
 
-- 项目文档  **[docs.DragonOS.org](https://docs.dragonos.org)**
 
 
-- **了解开发动态、开发任务,请访问DragonOS社区论坛**: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
+  如果你愿意加入我们,你可以查看issue,并在issue下发表讨论、想法,或者访问DragonOS的论坛,了解开发动态、开发任务: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
 
 
-- 软件镜像站 **[mirrors.DragonOS.org](https://mirrors.DragonOS.org)**
-- Git镜像站 **[git.mirrors.DragonOS.org](https://git.mirrors.DragonOS.org)**
-- 国内镜像站 **[mirrors.DragonOS.org.cn](https://mirrors.DragonOS.org.cn)**
+  你也可以带着你的创意与想法,和社区的小伙伴一起讨论,为DragonOS创造一些新的功能。
 
 
-- 开发交流QQ群 **115763565**
+## 网站
+
+
+- 项目官网  **[DragonOS.org](https://dragonos.org)**
+- 文档:**[docs.dragonos.org](https://docs.dragonos.org)**
+- 社区介绍文档: **[community.dragonos.org](https://community.dragonos.org)**
 
 
-- 代码搜索引擎 [code.DragonOS.org](http://code.dragonos.org)
-  
-   
 
 
 ## 如何运行?
 ## 如何运行?
 
 
@@ -52,34 +52,20 @@
 
 
 - [构建DragonOS — DragonOS dev 文档](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
 - [构建DragonOS — DragonOS dev 文档](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
 
 
-## 系统特性
-
-  请参见文档:[系统特性](https://docs.dragonos.org/zh_CN/latest/introduction/features.html)
-
-## 如何加入?
 
 
-  如果你愿意加入我们,你可以查看issue,并在issue下发表讨论、想法,或者访问DragonOS的论坛,了解开发动态、开发任务: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
-
-  你也可以带着你的创意与想法,和社区的小伙伴一起讨论,为DragonOS创造一些新的功能。
 
 
 ## 如何与社区建立联系?
 ## 如何与社区建立联系?
 
 
-  你可以发邮件给Maintainer: longjin,邮件地址是 [[email protected]](mailto:[email protected]) 。
-
-  或者是加入我们的开发交流QQ群:**115763565**
-
-  对于正式问题的讨论,请在 **[https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)** 上的对应板块,使用正式的语言发帖讨论。亦或者是在本仓库的issue下提出问题。
+请阅读[贡献者指南](https://community.dragonos.org/contributors/#%E7%A4%BE%E5%8C%BA)~
 
 
+- 您可以通过[社区管理团队]信息,与各委员会的成员们建立联系~
+- 同时,您可以通过[SIGs]和[WGs]页面,找到对应的社区团体负责人的联系方式~
 
 
 ## 贡献者名单
 ## 贡献者名单
 
 
 [Contributors to DragonOS-Community/DragonOS · GitHub](https://github.com/DragonOS-Community/DragonOS/graphs/contributors)
 [Contributors to DragonOS-Community/DragonOS · GitHub](https://github.com/DragonOS-Community/DragonOS/graphs/contributors)
 
 
-## 联系我们
 
 
-社区对外联系邮箱:[email protected]
-
-社区负责人邮箱:[email protected]
 
 
 ## 赞助
 ## 赞助
 
 
@@ -134,32 +120,10 @@
 
 
 **我们谴责**:任何不遵守开源协议的行为。包括但不限于:剽窃该项目的代码作为你的毕业设计等学术不端行为以及商业闭源使用而不付费。
 **我们谴责**:任何不遵守开源协议的行为。包括但不限于:剽窃该项目的代码作为你的毕业设计等学术不端行为以及商业闭源使用而不付费。
 
 
-若您发现了任何违背开源协议的使用行为,我们欢迎您发邮件反馈!让我们共同建设诚信的开源社区。
-
-## 参考资料
-
-  本项目参考了以下资料,我对这些项目、书籍、文档的作者表示感谢!
-
-- 《一个64位操作系统的实现》田宇(人民邮电出版社)
-
-- 《现代操作系统 原理与实现》陈海波、夏虞斌(机械工业出版社)
-
-- [SimpleKernel](https://github.com/Simple-XX/SimpleKernel)
-
-- [osdev.org](https://wiki.osdev.org/Main_Page)
-
-- ACPI_6_3_final_Jan30
-
-- the GNU GRUB manual
-
-- Intel® 64 and IA-32 Architectures Software Developer’s Manual
-
-- IA-PC HPET (High Precision Event Timers) Specification
-
-- [skiftOS]([GitHub - skiftOS/skift: 🥑 A hobby operating system built from scratch in modern C++. Featuring a reactive UI library and a strong emphasis on user experience.](https://github.com/skiftOS/skift))
-
-- [GuideOS](https://github.com/Codetector1374/GuideOS)
+若您发现了任何违背开源协议的使用行为,我们欢迎您发邮件到 [email protected] 反馈!让我们共同建设诚信的开源社区。
 
 
-- [redox-os](https://gitlab.redox-os.org/redox-os/redox)
 
 
-- [rcore](https://github.com/rcore-os/rCore)
+[DragonOS社区介绍文档]: https://community.dragonos.org/
+[社区管理团队]: https://community.dragonos.org/governance/staff-info.html
+[SIGs]: https://community.dragonos.org/sigs/
+[WGs]: https://community.dragonos.org/wgs/

+ 21 - 59
README_EN.md

@@ -25,52 +25,37 @@
 
 
   Driven by the community, DragonOS is currently evolving rapidly. DragonOS has already implemented about 1/4 of Linux interfaces, and in the future, we will strive to provide 100% compatibility with Linux, along with new features.
   Driven by the community, DragonOS is currently evolving rapidly. DragonOS has already implemented about 1/4 of Linux interfaces, and in the future, we will strive to provide 100% compatibility with Linux, along with new features.
 
 
-[All you want to know about DragonOS is here - DragonOS](https://dragonos.org/?p=46)
 
 
-## Websites
+## Get Involved in Development?
 
 
-- Home Page  **[DragonOS.org](https://dragonos.org)**
-- Documentation  **[docs.DragonOS.org](https://docs.dragonos.org)**
-- **To learn about development dynamics and development tasks, please visit DragonOS's BBS:** [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
-- Software mirror website **[mirrors.DragonOS.org](https://mirrors.DragonOS.org)**
-- Git mirror website **[git.mirrors.DragonOS.org](https://git.mirrors.DragonOS.org)**
-- QQ group **115763565**
-- Code search engine [code.DragonOS.org](http://code.dragonos.org) 
+Carefully read the [DragonOS Community Introduction Document] to understand how the community operates and how you can contribute!
 
 
-## How to run?
+- **To stay updated on development news and tasks, visit the DragonOS Community Forum**: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
+- You can also learn about the development progress by checking the project's issues.
 
 
-  The steps to run DragonOS are very simple. You can refer to the following information to run DragonOS within 15 minutes at the fastest!
+  If you're interested in joining us, you can check out the issues and post your discussions or ideas under them, or visit the DragonOS forum to learn about development updates and tasks: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
 
 
-- [Building DragonOS - DragonOS dev document](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
+  You're also welcome to bring your creative ideas and discuss them with the community members, working together to create new features for DragonOS.
 
 
-## DragonOS' Features
 
 
-  See documentation:[Features](https://docs.dragonos.org/zh_CN/latest/introduction/features.html)
+## Website
 
 
-## How to join DragonOS ?
+- **Project's Website**: [DragonOS.org](https://dragonos.org)
+- Documentation: [docs.dragonos.org](https://docs.dragonos.org)
+- Community Introduction Document: [community.dragonos.org](https://community.dragonos.org)
 
 
-  If you are willing to join us, you can visit DragonOS's BBS , learn about development dynamics and development tasks: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
+## How to Run?
 
 
-  Or, you can also bring your ideas, discuss with community members, and create some new functions for DragonOS.
+  Running DragonOS is quite straightforward. You can refer to the following resources and get DragonOS up and running in as little as 15 minutes!
 
 
-## How to contact the community?
+- [Building DragonOS — DragonOS Development Documentation](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
 
 
-  You can send an email to the project's maintainer: longjin. His email address is [[email protected]](mailto: [email protected]) .
+## How to Connect with the Community?
 
 
-  Or join our development exchange QQ group: **115763565**
+Please read the [Contributor Guide](https://community.dragonos.org/contributors/#%E7%A4%BE%E5%8C%BA)~
 
 
-  For the discussion of formal issues, we recommend that you use the official language to post on the corresponding section of **[https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)**. Or you can post questions under the issue of this repository.
-
-
-## List of contributors
-
-[Contributors to DragonOS-Community/DragonOS · GitHub](https://github.com/DragonOS-Community/DragonOS/graphs/contributors)
-
-## Get contact with us
-
-Community Contact Email: [email protected]
-
-Maintainer longjin's Email:[email protected]
+- You can establish contact with the members of various committees through the [Community Management Team] information.
+- Additionally, you can find the contact information of the respective community group leaders via the [SIGs] and [WGs] pages.
 
 
 
 
 ## Reward
 ## Reward
@@ -128,30 +113,7 @@ We guarantee that all sponsorship funds and items will be used for:
 
 
 If you find any violation of the open source license, we welcome you to send email feedback! Let's build an honest open source community together!
 If you find any violation of the open source license, we welcome you to send email feedback! Let's build an honest open source community together!
 
 
-## References
-
-  This project refers to the following materials. I sincerely give my thanks to the authors of these projects, books and documents!
-
-- Implementation of a 64 bit operating system, Tian Yu (POSTS&TELECOM  PRESS)
-
-- Principle and implementation of modern operating system, Chen Haibo, Xia Yubin (China Machine Press)
-
-- [SimpleKernel](https://github.com/Simple-XX/SimpleKernel)
-
-- [osdev.org](https://wiki.osdev.org/Main_Page)
-
-- ACPI_6_3_final_Jan30
-
-- the GNU GRUB manual
-
-- Intel® 64 and IA-32 Architectures Software Developer’s Manual
-
-- IA-PC HPET (High Precision Event Timers) Specification
-
-- [skiftOS]([GitHub - skiftOS/skift: 🥑 A hobby operating system built from scratch in modern C++. Featuring a reactive UI library and a strong emphasis on user experience.](https://github.com/skiftOS/skift))
-
-- [GuideOS](https://github.com/Codetector1374/GuideOS)
-
-- [redox-os](https://gitlab.redox-os.org/redox-os/redox)
-
-- [rcore](https://github.com/rcore-os/rCore)
+[DragonOS Community Introduction Document]: https://community.dragonos.org/
+[Community Management Team]: https://community.dragonos.org/governance/staff-info.html
+[SIGs]: https://community.dragonos.org/sigs/
+[WGs]: https://community.dragonos.org/wgs/