GitHub是啥？GitHub如何使用

Posted 2023-04-17

一、 GitHub是一个源代码的在线托管平台，提供了版本控制和协同工作功能。

二、GitHub使用步骤：

步骤一、创建一个知识库

在GitHub里，知识库总是用来组织某一个特定的项目。知识库可以包含文件夹，文件，图片，音频，视频，数据表或数据集--任何你的项目需要的文件都可以。

步骤二、创建一个分支

分支是同时对一个知识库或者说项目进行工作进行版本区分的方式。

默认的情况每一个知识库都会有一个master分支，这是所在项目的主分支，可以理解为项目的生产环境或正式环境。

步骤三、修改并提交

目前就在 readme-edits 分支里，这是 master的一个拷贝。接下来来进行一些修改。

在GitHub要把修改和提交叫作commits。每一次的commit 都需要一个commit message，用来说明这次修改的目的。Commit 

messages保存了所有修改的日志，这样别人可以看出来这个项目作了哪些修改和为什么要做这些修改。

步骤四、创建一个合并请求

合并请求是GitHub进行团队协作的核心，当创建一个合并请求的时候，所做的就是提议将修改合并到别的分支中去。合并请求时会显示两个分支的不同之处，通过绿色和红色来标识新增或删除。

步骤五、合并请求

在这最后一步我们要做的就是把你修改过的分支readme-edits合并到master分支中去。

点击 Merge pull request按钮。

点击Confirm merge。

点击 Delete branch 按钮来删除已经不需要的分支。

参考技术A github是什么：
　　Git是一个分布式的版本控制系统，最初由Linus Torvalds编写，用作Linux内核代码的管理。在推出后，Git在其它项目中也取得了很大成功，尤其是在Ruby社区中。目前，包括Rubinius和Merb在内的很多知名项目都使用了Git。Git同样可以被诸如Capistrano和Vlad the Deployer这样的部署工具所使用。
　　github使用教程：
　　1. 在系统天堂下载Github for Windows，然后安装就不说了
　　2. 登陆，安装好后打开GitHub，用你的GitHub账号登陆。需要注意的事，Github for Windows会帮你创建SSH Key，你打开邮件应该会收到邮件帮你创建SSH Key的信息，这也省了不少事：
　　3. 创建一个仓库。点击上面的 “+Add” 按钮创建一个新的仓库，输入相关信息：
　　4. 新建的仓库还没有真正地提交到本地仓库，相当于这只是一个new的修改，github简化了一些操作过程，对于任何修改，只需要添加评论就可以提交到本地仓库，然后这个时候才可以提交到远程仓库，所以我们来添加一条评论：
　　在每次添加一个评论之后，就相当于向本地仓库提交了一本版本，之后，就可以选择一个版本向远处仓库提交了。
　　5. 这个时候我们就可以Publish一个仓库了，Publish之后按钮就变成in sync文字，表示以后的修改提交就是同步，这个时候你到你的github上看应该就会多一个仓库了：
　　6. 添加项目，仓库在本地保存在一个文件夹中，Github for windows会监视这个文件夹，任何修改都会在仓库中看到，然后像上面一样添加评论就可以将修改提交到本地仓库，这里我们打开仓库目录，往里面添加一个项目：
　　7. 将修改提交到本地仓库，回到Github for windows中，已经可以看到刚才添加的项目了，同样，提交注释提交到本地仓库：
　　8. 最后，点击sync将本地仓库提交到github
　　9. 参与开源项目协同开发：
　　github现在已经深度支持Windows开发者了，现在每个在github的开源项目前面都有一个“Clone in Windows”的按钮，我们可以Clone任何我们感兴趣的开源项目，然后在地进行修改，参与开源项目的开发。
　　点击该按钮之后，浏览器会要求打开Github for Windows，并下载项目至本地，新建一个本地仓库：
　　总结：github for Windows简化了一些概念和操作，并且几乎所有主要操作都通过图形界面来完成，基本上能完成日常写作了。这些主要的简化包括：
　　1. 将push到远程仓库简化为一个同步按钮
　　2. 将提交到本地仓库简化为只需要对一些列修改添加评论
　　更多的，还包括分支的建立和管理，这部分自己去探索吧，总之，github for Windows确实是一个非常好的工具。本回答被提问者和网友采纳 参考技术B

Git是一个分布式的版本控制系统，最初由Linus Torvalds编写，用作Linux内核代码的管理。在推出后，Git在其它项目中也取得了很大成功，尤其是在Ruby社区中。目前，包括Rubinius和Merb在内的很多知名项目都使用了Git。Git同样可以被诸如Capistrano和Vlad the Deployer这样的部署工具所使用。同样，eoe.cn客户端的源码也托管在github上。

【如何使用】

1.注册账户以及创建仓库
要想使用github第一步当然是注册github账号了。之后就可以创建仓库了（免费用户只能建公共仓库），Create a New Repository，填好名称后Create，之后会出现一些仓库的配置信息，这也是一个git的简单教程。

2.安装客户端msysgit
github是服务端，要想在自己电脑上使用git我们还需要一个git客户端，我这里选用msysgit，这个只是提供了git的核心功能，而且是基于命令行的。如果想要图形界面的话只要在msysgit的基础上安装TortoiseGit即可。

装完msysgit后右键鼠标会多出一些选项来，在本地仓库里右键选择Git Init Here，会多出来一个.git文件夹，这就表示本地git创建成功。右键Git Bash进入git命令行，为了把本地的仓库传到github，还需要配置ssh key。

3.配置Git

首先在本地创建ssh key；

ssh-keygen -t rsa -C "[e-mail]"

后面的[e-mail]改为你的邮箱，之后会要求确认路径和输入密码，我们这使用默认的一路回车就行。成功的话会在~/下生成.ssh文件夹，进去，打开id_rsa.pub，复制里面的key。

回到github，进入Account Settings，左边选择SSH Keys，Add SSH Key,title随便填，粘贴key。为了验证是否成功，在git bash下输入：

$ ssh -T [e-mail]

如果是第一次的会提示是否continue，输入yes就会看到：You’ve successfully authenticated, but GitHub does not provide shell access 。这就表示已成功连上github。

接下来我们要做的就是把本地仓库传到github上去，在此之前还需要设置username和email，因为github每次commit都会记录他们。

$ git config --global user.name "bjpowernode"  
$ git config --global user.email "[e-mail]"

进入要上传的仓库，右键git bash，添加远程地址：

$ git remote add origin [e-mail]:yourName/yourRepo.git

后面的yourName和yourRepo表示你再github的用户名和刚才新建的仓库，加完之后进入.git，打开config，这里会多出一个remote “origin”内容，这就是刚才添加的远程地址，也可以直接修改config来配置远程地址。

4.提交、上传

接下来在本地仓库里添加一些文件，比如README，

$ git add README  
$ git commit -m "first commit"

上传到github：

$ git push origin master

git push命令会将本地仓库推送到远程服务器。
git pull命令则相反。

修改完代码后，使用git status可以查看文件的差别，使用git add 添加要commit的文件，也可以用git add -i来智能添加文件。之后git commit提交本次修改，git push上传到github。

github 上 Python 包的 README 格式是啥？

【中文标题】github 上 Python 包的 README 格式是啥？

【英文标题】：What format for a Python package's README on github?github 上 Python 包的 README 格式是什么？

【发布时间】：2014-10-15 04:41:10

【问题描述】：

setup.py 中的 Python distutils 在包的根目录中查找 README 和 README.txt。 github 可以识别README.md 和README.rst 等格式。如何编写一个格式化的根级 README 文件同时满足两者？

我在这里看到的唯一建议是运行 Pandoc 在格式之间进行转换。如果可能，我想避免添加额外的构建步骤。

有没有办法告诉distutils“使用我的README.rst”？

另外，当我运行python setup.py sdist 时忽略此警告是否会产生任何不良影响？

warning: sdist: standard file not found: should have one of README, README.txt

附言。我正在使用distutils.core，因为谷歌引导我here。是不是已经过时了？

【问题讨论】：

ln -s README.md README ?由于降价来源是“人类友好的”，这可能就足够了......

【参考方案1】：

看起来答案是使用setuptools 而不是distutils.core。如果您关注setuptools instructions，您可以了解如何将您的默认 README 设置为 .rst 文件。