本仓库是实验室的同学们对研究生阶段的一些经验的整理,主要有下面的目的:
- 给实验室新来的师弟师妹提供一些参考;
- 通过多人协作编辑文档,上手
git
,在这里操作出错不会有任何风险,大家可以在这里尽请尝试 :);
这是一个集众人智慧的仓库,当然,磨刀不误砍柴工,先来看看有哪些需要注意和准备的吧:
git
上手。关于git
的入门资料可以参见入门-常用工具
。不建议直接在网页上编辑,建议将仓库clone到本地进行编辑,完成编辑之后再push上来,方便体会暂存区、存储区、远程仓库等概念;markdown
上手。建议使用markdown
进行编辑,即使用.md
后缀的文件,方便其他人编辑修改。markdown
语法相对简单,上网搜一搜很快就能上手;- 文件结构说明。掌握了上面的两个“工具”之后,就可以开始贡献自己的力量了,目前主要是分成入门和进阶两个文件夹,每个文件夹下面有一些子文件夹,大家可以根据需要添加文件夹和文件,或者对文件夹中的文件进行编辑修改,如上所述,新建的文件建议是
.md
文件,使用markdown
语法。如果需要上传一些相关的资料,尽量控制一下资料的大小,如果要分享的资料比较大,可以上传到实验室的网络存储器,然后以链接的形式分享。 - 文档内容说明。
- 写文档的时候尽量简短。不用很详细的笔记,只需要给出关键点和相关的参考链接即可。
- 可以根据需要调整文档中内容的顺序。