Skip to content

kl-lab/KLLAB-Guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 

Repository files navigation

KLLAB 新同学入门指南

康老师的主页:https://yanfei.site/

李老师的主页:https://feng.li/

KLLab 的主页:https://kllab.org

关于 code

  1. 技能掌握:熟练使用 git 以及 Github ,附送一份 git 教程
  2. 项目实践:单独创建 GitHub 仓库,把 code 整理好,给康老师李老师以及其他合作者修改权限

关于 Presentation

  1. 展示内容:研究/项目的进展及结果、遇到的问题
  2. 展示方式:最好以 slides 或 html 的方式展示,避免 PowerPoint
    • 新加入的同学可以从最简单的 slides 或 html 形式开始展示,逐步学习
    • 可以使用一些基于 markdown、Rmarkdown、latex 的转 slides 或 html 的工具,KLLAB 有基于Rmarkdown的多种模板供参考和学习
    • 如果没有时间做 slides,也可以使用 markdown、Rmarkdown 将自己需要展示的内容及实验结果生成为文档,导出成 PDF 或 html 进行展示,详情可参考文档工具
  3. 展示时间:控制在15-30分钟

文档工具

下面是比较推荐的几种文档工具

  1. Markdown,相关工具 Typora
  2. RMarkdown,这是内嵌在 Rstudio 内部的工具,项目主要是 R 语言时推荐
  3. tex,比较复杂的工具,在写报告、Paper 时使用

知识共享

在读论文、做项目的时候总会学到一些新知识,这些知识可以以文档、slides 等方式进行总结,进而知识沉淀,既方便自己总结复习,也可以方便与其他同学分享和展示。可以用下面两种方式进行:

  1. 创建 git 项目,将文档和 slides 等和 code 放在一起,优点在于方便协作和版本控制,缺点在于复习和其他同学看起来不方便(GitHub对tex、Markdown、Rmakrdown、pdf 的阅读支持都不是那么优秀,甚至需要 clone 下来去阅读)
  2. 使用团队协作的知识管理工具,KLLAB 有建立一个语雀空间,加入以后可以创建并共享知识库。文档、文件等上传在语雀空间都很方便,且对 Markdown 的支持友好

欢迎大家加入KLLAB!

Releases

No releases published

Packages

No packages published