TJCS-Course icon indicating copy to clipboard operation
TJCS-Course copied to clipboard

Plan README!

Open skyleaworlder opened this issue 5 years ago • 2 comments

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

各课程的总 README 规范如下:

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

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

skyleaworlder avatar Jul 12 '20 15:07 skyleaworlder

@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
  • (免责)声明

ganler avatar May 28 '21 18:05 ganler

@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 的计划,到时候会仔细考虑该建议的!

skyleaworlder avatar May 29 '21 04:05 skyleaworlder