Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

编写规范的 README 文档 | Howie's Notes #122

Open
howiezhao opened this issue Apr 15, 2021 · 0 comments
Open

编写规范的 README 文档 | Howie's Notes #122

howiezhao opened this issue Apr 15, 2021 · 0 comments
Labels
92c8c919e00e5453e06eb2594f9dd668 Gitalk

Comments

@howiezhao
Copy link
Owner

https://howiezhao.github.io/2018/11/02/write-standard-readme/

代码不仅是写给计算机的，也是写给人的，一篇文档的好坏直接影响着使用此代码的人的心情，针对小的项目，一般使用 README 文件来做整体描述，README 这个名字也极好的反映了此文件的目的，即“读我”。有趣的是，README 这 6 个字母通常都是大写的，这是因为在 Linux 中大写的文件名往往意味着醒目和值得注意。实际上，并没有任何人规定 README 文档应该写成什么样子，但在本文中，我将介
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
92c8c919e00e5453e06eb2594f9dd668 Gitalk
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@howiezhao