如何寫好Github中的readme？

01-03

好的readme，如何才算好，一定要有高逼格，好吧，中文不夠國際化，一定要有英文版本

首先logo很重要放在最上面，如meolu/walle-web · GitHub，然後起一個最耍帥的名字，如meolu/walden · GitHub：Walden 最適合東半球同學使用的文檔框架。

最重要的，一定要有一個官方主頁介紹，不求漂亮、高大上，至少做得大方得體，瓦爾登官方主頁：Walden 瓦爾登。最好為它申請一個專業的域名，如瓦力官方主頁：walle-web.io，.io域名比.com貴太多了：( 不過，好馬配好鞍，誰讓它是我的理想寄託，值！

介紹當然是少不了，這塊可高大上，可幽默，看個人文筆了，目前我還沒想好一套超酷的，先等著。

對於技術的readme，一定要各種icon：travis、scrutinizer、packagist這些標配

至於什麼安裝，快速開始，功能列表這不啰嗦了，然後就是盡量給個截圖或者gif，吸引興趣，讓用戶看到完成之後的樣子。帶個todo list，告訴用戶我們還要繼續做，很有盼頭！

然後就是要帶流程圖、原理圖，畫漂亮點，這些都是得分點，讓用戶更清楚了解，減少解答。當然，最好自帶FAQ！！！

自帶change log，讓用戶知道每個版本都有哪些更新，修正了哪些bug。

最後就是問題交流，放上issue地址和qq群，促進交流，及時發現問題。最近meolu/walle-web · GitHub保持高速更新發版，就是跟用戶互動發現需求和問題的，歡迎試用標星，fork: )

謝邀，不過我沒有寫過readme的經歷。如果現在要我寫的話，我只能先參考下那些已經寫好的。有段時間我研究過sublime text的插件，不少插件源碼是放在github上的，readme寫得很清晰漂亮，至少把設置和使用方法都寫清楚了。看到不少代碼中的readme是.md格式的，看來markdown很流行。還有一個readme給我留下深刻印象的是lighttpd。

guodongxiaren/README

敬請關注

一個完整的readme，應當包括一下幾個部分：

首先是自述，對自己的項目進行簡潔全面的概述，包括項目來源，項目主要內容，各個部分功能，項目完成主要針對的目標。

其次，要在readme中添加contribute，如果你的項目足夠好，並且吸引了別人來貢獻，那麼你首先要讓別人知道要幹什麼，並且告知他關於貢獻的一些事項，比如功能，目的，風格等等。

最後，還應該包括項目的後期研發計劃。

你就當作LOG寫，格式如下

時間:動作，目的，測試用例，測試結果