Skip to content

Commit 791d60b

Browse files
fslongjinSamuka007
authored andcommitted
doc: 完善README.md (DragonOS-Community#849)
* doc: 完善README.md
1 parent 49e252b commit 791d60b

File tree

2 files changed

+41
-115
lines changed

2 files changed

+41
-115
lines changed

README.md

Lines changed: 20 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -26,60 +26,46 @@
2626
  DragonOS目前在社区驱动下正在快速发展中,目前DragonOS已经实现了约1/4的Linux接口,在未来我们将提供对Linux的100%兼容性,并且提供新特性。
2727

2828

29-
[关于DragonOS,你想了解的都在这儿 - DragonOS](https://dragonos.org/?p=46)
29+
## 参与开发?
3030

31-
## 网站
31+
仔细阅读 [DragonOS社区介绍文档] ,能够帮助你了解社区的运作方式,以及如何参与贡献!
3232

33-
- 项目官网 **[DragonOS.org](https://dragonos.org)**
33+
- **了解开发动态、开发任务,请访问DragonOS社区论坛**[https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
34+
- 您也可以从项目的issue里面了解相关的开发内容。
3435

35-
- 项目文档 **[docs.DragonOS.org](https://docs.dragonos.org)**
3636

37-
- **了解开发动态、开发任务,请访问DragonOS社区论坛**[https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
37+
  如果你愿意加入我们,你可以查看issue,并在issue下发表讨论、想法,或者访问DragonOS的论坛,了解开发动态、开发任务: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
3838

39-
- 软件镜像站 **[mirrors.DragonOS.org](https://mirrors.DragonOS.org)**
40-
- Git镜像站 **[git.mirrors.DragonOS.org](https://git.mirrors.DragonOS.org)**
41-
- 国内镜像站 **[mirrors.DragonOS.org.cn](https://mirrors.DragonOS.org.cn)**
39+
  你也可以带着你的创意与想法,和社区的小伙伴一起讨论,为DragonOS创造一些新的功能。
4240

43-
- 开发交流QQ群 **115763565**
41+
## 网站
42+
43+
44+
- 项目官网 **[DragonOS.org](https://dragonos.org)**
45+
- 文档:**[docs.dragonos.org](https://docs.dragonos.org)**
46+
- 社区介绍文档: **[community.dragonos.org](https://community.dragonos.org)**
4447

45-
- 代码搜索引擎 [code.DragonOS.org](http://code.dragonos.org)
46-
47-
 
4848

4949
## 如何运行?
5050

5151
  运行DragonOS的步骤非常简单,您可以参考以下几个资料,在最短15分钟内运行DragonOS!
5252

5353
- [构建DragonOS — DragonOS dev 文档](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
5454

55-
## 系统特性
56-
57-
  请参见文档:[系统特性](https://docs.dragonos.org/zh_CN/latest/introduction/features.html)
58-
59-
## 如何加入?
6055

61-
  如果你愿意加入我们,你可以查看issue,并在issue下发表讨论、想法,或者访问DragonOS的论坛,了解开发动态、开发任务: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
62-
63-
  你也可以带着你的创意与想法,和社区的小伙伴一起讨论,为DragonOS创造一些新的功能。
6456

6557
## 如何与社区建立联系?
6658

67-
  你可以发邮件给Maintainer: longjin,邮件地址是 [[email protected]](mailto:[email protected])
68-
69-
  或者是加入我们的开发交流QQ群:**115763565**
70-
71-
  对于正式问题的讨论,请在 **[https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)** 上的对应板块,使用正式的语言发帖讨论。亦或者是在本仓库的issue下提出问题。
59+
请阅读[贡献者指南](https://community.dragonos.org/contributors/#%E7%A4%BE%E5%8C%BA)~
7260

61+
- 您可以通过[社区管理团队]信息,与各委员会的成员们建立联系~
62+
- 同时,您可以通过[SIGs][WGs]页面,找到对应的社区团体负责人的联系方式~
7363

7464
## 贡献者名单
7565

7666
[Contributors to DragonOS-Community/DragonOS · GitHub](https://github.com/DragonOS-Community/DragonOS/graphs/contributors)
7767

78-
## 联系我们
7968

80-
社区对外联系邮箱:[email protected]
81-
82-
社区负责人邮箱:[email protected]
8369

8470
## 赞助
8571

@@ -134,32 +120,10 @@
134120

135121
**我们谴责**:任何不遵守开源协议的行为。包括但不限于:剽窃该项目的代码作为你的毕业设计等学术不端行为以及商业闭源使用而不付费。
136122

137-
若您发现了任何违背开源协议的使用行为,我们欢迎您发邮件反馈!让我们共同建设诚信的开源社区。
138-
139-
## 参考资料
140-
141-
  本项目参考了以下资料,我对这些项目、书籍、文档的作者表示感谢!
142-
143-
- 《一个64位操作系统的实现》田宇(人民邮电出版社)
144-
145-
- 《现代操作系统 原理与实现》陈海波、夏虞斌(机械工业出版社)
146-
147-
- [SimpleKernel](https://github.com/Simple-XX/SimpleKernel)
148-
149-
- [osdev.org](https://wiki.osdev.org/Main_Page)
150-
151-
- ACPI_6_3_final_Jan30
152-
153-
- the GNU GRUB manual
154-
155-
- Intel® 64 and IA-32 Architectures Software Developer’s Manual
156-
157-
- IA-PC HPET (High Precision Event Timers) Specification
158-
159-
- [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))
160-
161-
- [GuideOS](https://github.com/Codetector1374/GuideOS)
123+
若您发现了任何违背开源协议的使用行为,我们欢迎您发邮件到 [email protected] 反馈!让我们共同建设诚信的开源社区。
162124

163-
- [redox-os](https://gitlab.redox-os.org/redox-os/redox)
164125

165-
- [rcore](https://github.com/rcore-os/rCore)
126+
[DragonOS社区介绍文档]: https://community.dragonos.org/
127+
[社区管理团队]: https://community.dragonos.org/governance/staff-info.html
128+
[SIGs]: https://community.dragonos.org/sigs/
129+
[WGs]: https://community.dragonos.org/wgs/

README_EN.md

Lines changed: 21 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -25,52 +25,37 @@
2525

2626
  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.
2727

28-
[All you want to know about DragonOS is here - DragonOS](https://dragonos.org/?p=46)
2928

30-
## Websites
29+
## Get Involved in Development?
3130

32-
- Home Page **[DragonOS.org](https://dragonos.org)**
33-
- Documentation **[docs.DragonOS.org](https://docs.dragonos.org)**
34-
- **To learn about development dynamics and development tasks, please visit DragonOS's BBS:** [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
35-
- Software mirror website **[mirrors.DragonOS.org](https://mirrors.DragonOS.org)**
36-
- Git mirror website **[git.mirrors.DragonOS.org](https://git.mirrors.DragonOS.org)**
37-
- QQ group **115763565**
38-
- Code search engine [code.DragonOS.org](http://code.dragonos.org) 
31+
Carefully read the [DragonOS Community Introduction Document] to understand how the community operates and how you can contribute!
3932

40-
## How to run?
33+
- **To stay updated on development news and tasks, visit the DragonOS Community Forum**: [https://bbs.dragonos.org.cn](https://bbs.dragonos.org.cn)
34+
- You can also learn about the development progress by checking the project's issues.
4135

42-
  The steps to run DragonOS are very simple. You can refer to the following information to run DragonOS within 15 minutes at the fastest!
36+
  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)
4337

44-
- [Building DragonOS - DragonOS dev document](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
38+
  You're also welcome to bring your creative ideas and discuss them with the community members, working together to create new features for DragonOS.
4539

46-
## DragonOS' Features
4740

48-
  See documentation:[Features](https://docs.dragonos.org/zh_CN/latest/introduction/features.html)
41+
## Website
4942

50-
## How to join DragonOS ?
43+
- **Project's Website**: [DragonOS.org](https://dragonos.org)
44+
- Documentation: [docs.dragonos.org](https://docs.dragonos.org)
45+
- Community Introduction Document: [community.dragonos.org](https://community.dragonos.org)
5146

52-
  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)
47+
## How to Run?
5348

54-
  Or, you can also bring your ideas, discuss with community members, and create some new functions for DragonOS.
49+
  Running DragonOS is quite straightforward. You can refer to the following resources and get DragonOS up and running in as little as 15 minutes!
5550

56-
## How to contact the community?
51+
- [Building DragonOS — DragonOS Development Documentation](https://docs.dragonos.org/zh_CN/latest/introduction/build_system.html)
5752

58-
  You can send an email to the project's maintainer: longjin. His email address is [[email protected]](mailto: [email protected]) .
53+
## How to Connect with the Community?
5954

60-
  Or join our development exchange QQ group: **115763565**
55+
Please read the [Contributor Guide](https://community.dragonos.org/contributors/#%E7%A4%BE%E5%8C%BA)~
6156

62-
  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.
63-
64-
65-
## List of contributors
66-
67-
[Contributors to DragonOS-Community/DragonOS · GitHub](https://github.com/DragonOS-Community/DragonOS/graphs/contributors)
68-
69-
## Get contact with us
70-
71-
Community Contact Email: [email protected]
72-
73-
Maintainer longjin's Email:[email protected]
57+
- You can establish contact with the members of various committees through the [Community Management Team] information.
58+
- Additionally, you can find the contact information of the respective community group leaders via the [SIGs] and [WGs] pages.
7459

7560

7661
## Reward
@@ -128,30 +113,7 @@ We guarantee that all sponsorship funds and items will be used for:
128113

129114
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!
130115

131-
## References
132-
133-
  This project refers to the following materials. I sincerely give my thanks to the authors of these projects, books and documents!
134-
135-
- Implementation of a 64 bit operating system, Tian Yu (POSTS&TELECOM PRESS)
136-
137-
- Principle and implementation of modern operating system, Chen Haibo, Xia Yubin (China Machine Press)
138-
139-
- [SimpleKernel](https://github.com/Simple-XX/SimpleKernel)
140-
141-
- [osdev.org](https://wiki.osdev.org/Main_Page)
142-
143-
- ACPI_6_3_final_Jan30
144-
145-
- the GNU GRUB manual
146-
147-
- Intel® 64 and IA-32 Architectures Software Developer’s Manual
148-
149-
- IA-PC HPET (High Precision Event Timers) Specification
150-
151-
- [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))
152-
153-
- [GuideOS](https://github.com/Codetector1374/GuideOS)
154-
155-
- [redox-os](https://gitlab.redox-os.org/redox-os/redox)
156-
157-
- [rcore](https://github.com/rcore-os/rCore)
116+
[DragonOS Community Introduction Document]: https://community.dragonos.org/
117+
[Community Management Team]: https://community.dragonos.org/governance/staff-info.html
118+
[SIGs]: https://community.dragonos.org/sigs/
119+
[WGs]: https://community.dragonos.org/wgs/

0 commit comments

Comments
 (0)