GitHub: Windows 下的簡單使用

這段時間在博客園多了不少關於GitHub的文章，可是個人確沒怎麼看懂。不過這幾天簡單的看了寫資料，親身操做以後也有了一點體會。這算是最簡單的GitHub入門了吧，基本全是鼠標操做。這也是這幾天的總結，和你們共同分享。文中若是有什麼錯誤或者不恰當的地方，還但願你們及時指正。關於GitHub的內容，主要參考了GotGitHub。

1. 背景和目的

    去年的時候，有個老師推薦使用GitHub來管理本身的代碼。這段時間博客園的首頁上多了不少關於GitHub的介紹。半年多來，我對我作的絕大多數事情都作了詳細的記錄，但願能把本身的工做保留下來。對於工做自己的一些經驗，採起文檔的形式，完成以後修改不是那麼的頻繁，可是代碼不同。不少時候，個人確發現須要好好整理本身的代碼了，好比說

 

    上圖是一個失敗的例子，文件夾內的多數文件具備相似的功能，可是又有一些差異。好吧，實際上就是當我要找某段代碼的時候，我本身都找不到了……發到首頁上的GitHub介紹都比較高級，說實話我不怎麼看得懂。因此本文的目的，就是利用我這幾天的經驗，最簡單的介紹一下GitHub for Windows（https://windows.github.com/）的應用。（在寫這一段的時候，發現博客園仍是有很基礎的介紹的，好比http://www.cnblogs.com/Yiutto/p/4665012.html）

2. Git和GitHub

  「GitHub（網址 https://github.com/）是一個面向開源及私有軟件項目的託管平臺，由於只支持Git做爲惟一的版本庫格式進行託管，故名GitHub。」（http://www.worldhello.net/gotgithub/01-explore-github/010-what-is-github.html）

    Git是一個分佈式的版本控制系統。版本控制，對於有且僅有我一我的參與的項目而言，需求實際上並非不少。我須要保存個人代碼並能夠便捷的查看，可以隨時的修改而不受網絡限制。能夠根據個人修改即便的更新代碼，而且提供更新先後的對比，更新說明記錄，同時根據更新記錄，能夠查找修改以前的代碼。除了代碼內的註釋，我還但願可以對整個項目作具體的說明，這不只有利於別人瞭解這是什麼，也時時刻刻提醒本身這是什麼，還有什麼須要修改的地方。這些需求都被輕鬆的知足了，固然，Git的魅力遠不在此。

    GotGitHub中有簡潔形象的關於Git的描述。對於一個你的開源的項目，參與者不只僅會是你自己，還有和你一塊兒的核心開發人員和但願加入的外圍開發人員。而你可能也會但願加入別人的開源項目。Git是如何協調這幾類人員之間的關係？我寫的確定沒有這裏的好，因此去這裏看吧……

3. 創建repository

    Repository: 版本庫

    帳號註冊和軟件安裝之類的不談（注意：帳號註冊以後，顯示在你的版本庫以前的名字是改不掉的），建立一個新版本庫是第一步（也能夠Fork別人的版本庫，這個先不談，由於我沒有作過）。網頁的操做都很簡單，還有詳盡的幫助，這一過程在網頁上完成就能夠了。只須要指定名稱，描述（可選），勾選上README，是否添加gitignore（不太懂，見Ignoring files），添加合適的license。點擊按鈕就能夠建立版本庫了。

    運行GitHub for Widnows，登陸你的GitHub帳號，點擊左上角的 '+' ，選擇Clone能夠複製雲端的版本庫到本地的指定位置。

 

    新創建的版本庫中只可能有README和Ignoring 文件。版本庫中的任何改變（文件添加、刪除和修改）都會體如今Changes中，文件名後的綠色表示添加內容，紅色表示刪除內容。完成修改後，寫上本次Commit的標題和內容，能夠點擊Commit按鈕上傳修改。若是在其餘地方對版本庫有修改，則須要先點擊同步按鈕獲取最新版本庫以後，纔可以上傳修改。

    任何的Commit都會記錄在History中，能夠在此處查看提交的內容，對比提交先後的變化，甚至能夠撤銷修改（經過從新提交修改的方式）。下圖分別是Changes（左）和History（右）的顯示。

4. README和其餘說明

    回到第二節的需求，其中有一條是「除了代碼內的註釋，我還但願可以對整個項目作具體的說明，這不只有利於別人瞭解這是什麼，也時時刻刻提醒本身這是什麼，還有什麼須要修改的地方」。

    第三節中初始化的README起到了這個做用，README會顯示在版本庫的下方（網頁），如

 

    .md後綴的README文件內容採用Markdown，Markdown基本語法見第五節。打開README.md文件，編輯便可，不放心的話還能夠找一個Markdown編輯器（參考），或者選擇一款在線編輯器。GitHub還提供了其餘的方式來展示整個版本庫的內容、功能。

    簡單的操做就能製做精美的項目主頁，在版本庫的設置中，點擊'Launch automatic page generator'，利用Markdown標記內容，以後選擇合適的模板就能夠生成精美的項目主頁，項目主頁域名爲<user-id>.github.io/<project-name>，譬如http://caowenhui.github.io/LDPCC/。

 

    這裏我直接將README中的內容添加到了項目主頁上，效果以下圖（效果取決於選擇的模板，本身寫也能夠）

   

    在網頁建立了項目主要以後，在GitHub for Windows 下同步後會發現，版本庫多了一個名爲gh-pages的分支。當咱們創建一個新的版本庫的時候，默認會建立一個master分支。那麼分支是用來幹什麼的呢？使用git 新建分支以及管理分支提到了這個問題，若是想測試某個功能，又不想改變主分支的內容，那麼能夠建立一個新的分支，這個分支會複製主分支的所有內容。

    而gh-pages是一個特殊的分支，gh-pages不包含主分支內容，在gh-pages中添加靜態網頁後，GitHub會自動調用該分支內的內容。

5. Markdown基本語法

    一般來講，撰寫文檔的時候會用到的基本格式、內容包括如下幾種

• 標題和標題級別
• 列表和有序列表
• 超連接
• 圖片

    下面將簡單介紹基本語法，更多內容可參考http://www.appinn.com/markdown/#p。

    標題一般採用如下方式，即經過#標識這是標題，經過#的個數標識這是幾級標題

# 這是一級標題
## 這是二級標題
###### 這是六級標題

    列表纔有*,+,-標識，如

*   Red
*   Green
*   Blue

    有序列表經過數字加英文的 '.' 標識，注意內容以前須要加上一個空格（有序列表的數字不必定須要有序，可是建議這樣作）

1.  Bird
2.  McHale
3.  Parish

    圖片和超連接具備相同的形式（圖片以前有一 '!'），即[文字](連接)的形式。

超連接表示形式：[博客](http://www.cnblogs.com/sea-wind2)
圖片表示形式 : ![誤碼率曲線](/BER.png)

6. 其餘

    最簡單的使用說明，功能遠沒有結束。其中最重要的一點是如何和他人共同工做？這個他人，可能指團隊內的合做者，或是其餘對這個項目感興趣其餘程序員，還多是不精通編程但對這個項目有一些看法的人。GitHub上的Fork，Pull，Issue等，這裏就先不作說明了，由於我也沒有什麼體會。