引言
本笔记适用于,对于git有基础的了解,并且本地电脑上的 SSH公钥 已经上传到远程仓库(gitee/github)。
小白可参照 廖雪峰老师git教程 该教程适合新手从0到1进行学习。 菜鸟教程 该教程更全面、详细。
笔记的初衷是本人已经在菜鸟教程和廖雪峰老师的网站中学习了git教程,但由于是新手每次进行工程版本管理时都需要翻看教程来防止自己出错,这样费时又费力,因此写了本篇笔记,来方便自己快速对一个新工程进行版本管理,也是对新知识进行温故而知新。
创建本地仓库
创建 .gitignore 文件(推荐)
.gitignore 文件的作用是,屏蔽掉你不想进行git管理的文件,以本人stm32工程为例,如下
屏蔽掉由keil编译产生的各种中间文件,这种文件数量众多,进行git管理和上传远程仓库后,工程的体积就会变得非常臃肿,对于上传和拉取都非常不便。
方法
- github上有各种模板的 .gitignore 文件,可以直接拉下来,修改成适合自己的进行使用。
- 也可以直接在工程目录下使用vscode或git 自带的vi/vim编辑器(不推荐使用记事本编辑),创建名称为 .gitignore 文件,并配置适合自己的忽略规则。
- .gitignore的配置规则可参考以下 教程。
- STM32 工程可以参考我的配置规则,如下
#屏蔽掉 keil 编译产生的中间文件,不进行 git 管理
#BJX -- 2024.01.05
*.axf
*.lnp
*.sct
*.dep
*.sct
*.crf
*.d
*.o
*.iex
*.vscode
*.dbgconf
*.map
*.lst
*.htm
创建本地仓库
- 在工程目录下,鼠标右键选择 Open Git Bash here 打开git命令面板(若没有安装git可参考以下教程,git安装教程)
- 输入 git init 回车,如下图则创建成功。
- 使用 git add . 命令把工程下除屏蔽文件外的所有文件,从工作区添加到暂存区。
- 使用 git commit -m ‘此处添加版本简要说明’ 把文件从暂存区提交到本地仓库。
- 使用 git status 可查看当前仓库状态,显示如下则表示工作区的文件全部提交完毕。
- 使用 git log --oneline 简要查看历史提交记录。
更多命令可参考我上面提到的两个教程。
创建远程仓库
注意!!! 首先要确保你电脑上的本地SSH公钥,已经添加到你要上传的远程仓库里。不清楚,可参考开头的两个教程。
- 以 gitee 为例,github 类同。步骤如下图
- 仓库名称,可根据项目名称来取,路径会根据名称自动生成,也可自己修改。最后点击创建就行。
- 创建完成后,首页会显示提示命令,如下
复制 git remote add origin git@gitee.com:BJX99/plz-u8g2.git 此命令,粘贴到git命令行里,把 origin 改为 gitee ,方便各位再添加多个远程仓库时,易于区分。
可使用 git remote -v 命令查看远程仓库信息。 - 第一次推送本地仓库到远程仓库时使用 git push -u gitee master 以后则可简写为 git push gitee master。
如上图所示,已完成推送,此时打开刚才建的gitee仓库就可以看到,你提交的文件了。
最后附上一份 git常用命令手册,新手写作,如有不正确的地方或其它问题,欢迎在评论区指正、交流。