Skip to content

gebumc/Physics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Physics

物理学生存指南

基本介绍

你好,这是《物理学生存指南》,我们创建这个项目的初衷是给每一位来到物理系的学生提供一些必要的帮助,以减少一些弯路。

目前我们还是处于起步阶段,只有样稿 release

如何加入我们为这个文档作出贡献?

  • 首先,这是一个简单的 $\LaTeX$ 文档,并且基于Overleaf上一个模板进行写作,因此您需要具备基本的 $\LaTeX$ 写作能力。
  • 这是一个基于 GitHub 的一个项目,因此也需要您具备一定的Git 和GitHub使用技能

获取项目文件

复制这个项目的GitHub 链接,在自己的终端选择一个合适的文件目录下输入

git clone git@github.com:Funyday-k/Physics.git

然后您就可以下载到该项目的源文件了

该项目基本构成

由于是在原模板的基础上进行更改的文档,所以我大致介绍一下这个tex文件的组成,如图

项目的基本组成

​ 分别介绍

  • Main:主文件夹
  • chapter:我们编写内容的时候,将每个章节的内容放在单独一个tex文件里,以实现模块化
  • image:章节 内容中出现的图片存放在这里,命名规则:章节名称_图片名称.jpg
  • figure: 主要tex以及README文件中出现的图片存放于此,命名规则:图片名称.jpg
  • main.tex: tex的主干文件,章节内容将用 include{chapter.tex} 的形式进行编译

我们尽量规范的编辑该文档,方便你我他。

如何协作?

  • 先与参与人员协商
  • 联系组织者获得管理项目的权限
  • 从远程克隆仓库到本地
  • 编辑相关内容
  • 如果推送失败,则因为远程分支比你的本地更新,需要先用git pull试图合并;
  • 如果合并有冲突,则解决冲突,并在本地提交;
  • 没有冲突或者解决掉冲突后,再用git push 推送就能成功!

(流程仅供参考)

About

物理学生存指南

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages