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.

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

Plan README! #7

Open
skyleaworlder opened this issue Jul 12, 2020 · 2 comments
Open

Plan README! #7

skyleaworlder opened this issue Jul 12, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@skyleaworlder
Copy link
Member

在艰苦的环境下(指 GitHub 对 Markdown 的渲染),写出清晰易懂的 README!

各课程的总 README 规范如下:

  • 一级标题:现课名
  • 二级标题:以 课号 课名 形式列出(考虑到课号变动,如曾经的汇编,12 级之前为 3 学分必修课
    • 三级标题:第一部分 总述
      • 四级标题:教材
      • 四级标题:作业
      • 四级标题:课堂
      • 四级标题:考试
    • 三级标题:第二部分 任课教师
      • 四级标题:以 工号 任课老师姓氏 列出

(注:尽量 简略 列出有关课程的 所有 内容)
(长期工作,缓慢进行……)
(README 意见专用 issue)

@skyleaworlder skyleaworlder added the documentation Improvements or additions to documentation label Jul 12, 2020
@skyleaworlder skyleaworlder self-assigned this Jul 12, 2020
@ganler
Copy link
Contributor

ganler commented May 28, 2021

@skyleaworlder Basically, I think a good readme is to go tidy and simple. Apparently, it was made a bit chaotic...

I would recommend we adhere to the following structure:

  • an introduction telling why we are here.
  • a table of content
  • (免责)声明

@skyleaworlder
Copy link
Member Author

@skyleaworlder Basically, I think a good readme is to go tidy and simple. Apparently, it was made a bit chaotic...

I would recommend we adhere to the following structure:

  • an introduction telling why we are here.
  • a table of content
  • (免责)声明

说得对啊!这个暑假有重写大部分 README 的计划,到时候会仔细考虑该建议的!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants