提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
文章目录
前言
在这个教程中,我将带你一步步了解如何在GitHub上创建一个新的仓库(Repository),并展示如何进行初始化、添加README文件,以及设置仓库的相关选项。适合编程新手或者刚接触GitHub,本教程会详细说明每一个步骤。
一、什么是GitHub仓库?
GitHub上的仓库是一个存储代码和其他项目文件的地方。它让开发者可以轻松地保存、共享和协作开发项目。仓库可以是公开的(任何人都可以查看)或私有的(只有被授权的人可以访问)。
二、新建Github仓库
1.登录(创建)Github账号
首先,你需要一个GitHub账户。如果你还没有GitHub账号,可以通过GitHub官网(https://github.com/)快速注册。操作如下:点击页面右上角的 Sign up
按钮,填写用户名、邮箱和密码,然后点击 Create account
,完成注册登录。
2.进入“新建仓库”页面
(1)登录后,在页面的右上角,点击你的头像旁边的+
号按钮;
(2)在下拉菜单中,选择 New repository
(新建仓库);
(3)或者直接点击左侧Dashboard
下方的New
进行新建仓库。
3.填写仓库信息
- Repository name(仓库名称):输入一个独特且有意义的仓库名称(例如:
my-first-repo
); - Description(描述):可以选择性地为仓库添加描述,解释这个仓库的用途或项目内容;
- Public or Private:选择仓库的可见性。
Public
表示任何人都可以看到你的仓库,Private
则表示只有你和你授权的人能查看仓库内容; - Initialize this repository with a README(初始化仓库时创建 README 文件):建议勾选这个选项,因为 README 文件是项目的介绍文件,有助于其他人理解你的项目;
- gitignore 文件(可选):如果你希望 Git 忽略某些文件(例如编译后的文件、配置文件等),可以选择一个适合你项目的模板;
- License(可选):为你的项目选择一个开源许可证。如果你不确定,可以先不选择,以后可以添加;
完成所有信息的填写后,点击页面下方的Create repository
按钮。恭喜你!你的第一个 GitHub 仓库已经创建成功。
4.仓库设置及选项
新仓库创建成功后,你会进入仓库的主页。在这里,你可以对仓库进行进一步的设置和操作。
仓库主页的主要功能:
- Code(代码):展示当前仓库的文件结构,点击可以查看文件内容。
- Issues(问题追踪):你可以使用 Issue 功能记录 Bug、任务、建议等。
- Pull requests(拉取请求):用于协作开发时,用户可以通过提交 Pull Request 提交修改。
- Actions(动作):自动化工作流配置,可以用来进行 CI/CD 等操作。
- Settings(设置):更改仓库的名称、描述、删除仓库等操作都在这里进行。
三、 使用 Git 命令行上传文件
创建仓库后,你可能想把本地项目的文件上传到 GitHub。这时需要使用 Git 命令行工具。
第一步:安装 Git
如果你还没有安装 Git,可以根据你的操作系统进行下载和安装:
第二步:配置 Git
安装完成后,找到并打开Git Bash;
使用以下命令来配置你的用户名和邮箱:
git config --global user.name "github上的注册的用户名" # 例如我的用户名 "AllenShaoMZ"
git config --global user.email "github上的注册的邮箱" # 例如我的邮箱 "xxx@163.com"
你可以使用以下命令来检查配置是否成功:
git config --global --list
第三步:使用 SSH 克隆仓库
GitHub 提供两种方式来连接仓库:HTTPS 和 SSH。本文介绍使用 SSH 克隆仓库到本地。
使用 SSH 的方式可以避免在每次推送时输入用户名和密码,但你需要先配置 SSH 密钥。
配置 SSH 密钥的步骤:
-
检查是否已有 SSH 密钥:首先检查你是否已经有 SSH 密钥。执行以下命令:
ls -al ~/.ssh
第一次建立的话是没有SSH密钥的,如果你已经有 SSH 密钥(通常是 id_rsa
和 id_rsa.pub
文件),可以跳过生成密钥的步骤。
-
生成 SSH 密钥:如果你没有 SSH 密钥,可以使用以下命令生成一个新的密钥:
ssh-keygen -t rsa -b 4096 -C "your-email@example.com" # 你的注册邮箱
你会被提示选择密钥的存储路径,通常可以直接按回车键,使用默认路径(
~/.ssh/id_rsa
)。之后你可以设置一个密码,也可以选择不设置。
-
添加 SSH 密钥到 SSH 代理:
启动 SSH 代理,并将生成的 SSH 密钥添加进去:
eval "$(ssh-agent -s)" ssh-add ~/.ssh/id_rsa
-
将 SSH 公钥添加到 GitHub:
复制 SSH 公钥(
id_rsa.pub
文件):cat ~/.ssh/id_rsa.pub
然后打开 GitHub,点击头像,进入 Settings > SSH and GPG keys,点击 New SSH key,将复制的公钥粘贴进去,并保存。
-
使用 SSH 克隆仓库:
完成 SSH 配置后,你可以使用 SSH 链接克隆仓库,选择一个本地的仓库文件夹,我习惯下载到D盘:
cd /D/allenshao_projrct/github # 根据个人习惯 git clone git@github.com:your-username/your-repository.git
第四步:将文件添加到仓库
克隆仓库后,你可以将项目文件添加到这个文件夹中。以下是将文件上传到 GitHub 的详细步骤:
-
将你本地的项目文件放入克隆下来的文件夹中。
-
在命令行中进入该文件夹:
cd your-repository
-
执行以下命令将文件添加到 Git:
git add .
-
然后提交更改,添加提交说明:
git commit -m "Initial commit"
-
最后,将本地的更改推送到 GitHub 仓库的
main
分支:git push origin main
如果你使用的是 HTTPS 链接,推送时 GitHub 会要求输入你的 GitHub 用户名和密码。而使用 SSH 链接,则不需要输入用户名和密码,因为 SSH 密钥已经起到身份验证的作用。
结语
恭喜你!通过这篇教程,你已经成功创建了你的第一个 GitHub 仓库,并将本地文件上传到了 GitHub。GitHub 不仅是一个代码托管平台,还是开发者社区、协作工具以及展示个人项目的窗口。
随着你对 Git 和 GitHub 的深入了解,你还可以学习更多关于分支管理、Pull Request、协作开发等功能。如果你有任何问题,欢迎留言交流!
希望这篇教程能帮助你顺利入门 GitHub。如果你觉得这篇文章有帮助,别忘了分享给其他需要的朋友!