github是一个基于git的代码托管平台，付费用户可以建私人仓库，一般的免费用户只能使用公共仓库，也就是代码要公开。这对于一般人来说公共仓库就已经足够了。
注册账户以及创建仓库
首先你要有一个github帐号，没有的话去github官网注册一个就好了
注册完成后创建一个新的仓库
点击New repository 创建一个新的仓库
如果选上
Initialize this repository with a README，这个意思是在建立仓库时自动生成 README.md 文件，看你自己的需要吧
关于README.md
了解一个项目，首先都是通过其Readme文件了解信息。
README.md有其特有的语法的。称之为Markdown语法。
README应该是介绍code source 的一个概览.其实这个静态文件是有约定成俗的规范.
1.你的项目介绍
2.你的代码实现了什么功能?
3.该如何使用? (系统环境参数,部署要素)
4.代码组织架构是什么样的?
5.版本更新重要摘要
readme.md书写事例
DEMO
===========================
###########环境依赖
node v0.10.28+
reids ~
###########部署步骤
1. 添加系统环境变量
export $PORTAL_VERSION="production" // production, test, dev
2. npm install //安装node运行环境
3. gulp build //前端编译
4. 启动两个配置(已forever为例)
eg: forever start app-service.js
forever start logger-service.js
###########目录结构描述
├── Readme.md // help
├── app // 应用
├── config // 配置
│ ├── default.json
│ ├── dev.json // 开发环境
│ ├── experiment.json // 实验
│ ├── index.js // 配置控制
│ ├── local.json // 本地
│ ├── production.json // 生产环境
│ └── test.json // 测试环境
├── data
├── doc // 文档
├── environment
├── gulpfile.js
├── locales
├── logger-service.js // 启动日志配置
├── node_modules
├── package.json
├── app-service.js // 启动应用配置
├── static // web静态资源加载
│ └── initjson
│ └── config.js // 提供给前端的配置
├── test
├── test-service.js
└── tools
###########V1.0.0 版本内容更新
1. 新功能 aaaaaaaaa
2. 新功能 bbbbbbbbb
3. 新功能 ccccccccc
4. 新功能 ddddddddd
点击创建按钮，github会给出如下所示操作代码提示。
echo "# test1" >> README.md
git init
git add README.md
git commit -m "first commit"
git remote add origin git@github.com:JinBinPeng/test1.git
git push -u origin master
github 是服务端，要想在自己电脑上使用 git 还需要一个 git 客户端
我这里是下载了git
然后配置 git
首先在本地创建 ssh key：
ssh-keygen -t rsa -C "your_email@youremail.com"
后面的 your_email@youremail.com 改为自己的邮箱，之后会要求确认路径和输入密码，这里使用默认的一路回车就行。成功的话会在 ~/ 下生成 .ssh文件夹，例如我的就在C:\Users\dell1\.ssh文件夹中
打开id_rsa.pub，复制里面的 key，这个key是以ssh-rsa开头的一长串字符，直接复制就好
回到 github，进入 settings，左边选择 SSH and GPG keys，Add SSH Key
title 随便填，粘贴 key
为了验证是否成功，在 git bash 下输入：
ssh -T git@github.com
当询问到yes/no时不要直接回车，不然会报错，yes就输入yes，no就输入no
如果是第一次的会提示是否 continue，输入 yes 就会看到：You've successfully authenticated, but GitHub does not provide shell access，这就表示已成功连上 github。
下一次输入时就不会在提示是否continue
接下来要做的就是把 github 上面建立的仓库克隆到本地
在此之前还需要设置 username 和 email，因为 github 每次 commit都会记录他们。
git config --global user.name "your name"
git config --global user.email "your_email@youremail.com"
在目录中创建新的 Git 仓库。
git init
初始化的版本库用户也可以在该目录下执行所有git方面的操作。
此命令会在当前目录下创建一个.git文件夹。包含所有git操作所需要的文件
克隆到本地
需要注意的是：github 提供了 2种 url 路径（HTTPS，SSH），一般如果账号处于登录状态，那么我们可以用 SSH，就像上面的代码，如果没有登录的话，只能用 HTTPS 的 url 了
git clone https/ssh的URL
https和SSH的 直接复制即可
比如我的是test1项目，clone完后会在当前目录生成一个test1文件夹，里面就包含.git文件夹
然后你把需要提交的文件复制粘贴到test1文件夹中
下面就可以进行修改，提交，上传
我们可以修改克隆到本地的项目，修改完成后先要
add修改的文件（. 表示全部,与前面add有个空格），然后填写 commit，最后在 push 到 github。
git add .
git commit -m "这次上传的主要描述"
git push
然后我们刷新我们github的仓库，发现已经上传上去了
如果你有需要修改里面的文件也是可以的，修改完后再次重复add，commit和push操作就可以了
在commit中会显示有多少个文件被修改
