build 構建腳本
dist 編譯出來的發布版
docs 文檔
examples 示例文件
src 源碼
test 測試腳本
.babelrc Babel 交叉編譯的配置
.eslintrc ESLint 測試配置
.gitignore 哪些文件不要上傳到 GitHub
.gitattributes 文件屬性,如 EOL、是否為二進制等
LICENSE 授權協議
README.md 自述文件,里面至少得寫:
項目的特色
各種 Badge 比如 CI 的
怎么下載安裝
示例運行/使用
怎么編譯(尤其 C/C++,要把編譯器、要裝什么工具、依賴庫全部寫清楚。要帶版本號!)
怎么參與
circle.yml Circle CI 持續集成配置文件(當然你可能用別的 CI,名字會變。比如我那個 otfcc 使用了兩個 CI:Travis 和 Appveyor,就寫了兩個配置)
bower.json Bower 包管理器配置文件
package.json npm 包管理器配置文件
github的使用-目錄解析
從github下載的項目目錄,總有一些剛開始我們不了解用處的文件,本文嘗試做一些整理歸納,希望你看了本文可以有所幫助,更有效率的使用github。
gitignore文件:定義不想在git中提交的文件
readMe:比較常見的項目說明文檔,通常是markdown格式的,后綴為md
package.json文件(javaScript項目):定義項目所需要的各種模塊,以及項目的配置信息(比如名稱、版本、許可證等元數據)。npm install 命令根據這個配置文件,自動下載所需的模塊
gruntfile.js(javaScript項目):https://blog.csdn.net/anway12138/article/details/79455365
composer.json:composer的配置文件, Java有Maven, Node.js有npm, composer就是PHP程序員的包管理工具。
bower.json:配置文件(什么是bower?一個前端包管理工具。作用:跟蹤前端包,並且保證他們是最新(或者是你指定的特定版本),能夠管理前端里面的HTML,CSS,JS,甚至還可以是圖片。如果多個包依賴於一個包,例如jQuery,那么Bower將只下載jQuery一次,這樣就稱為扁平依賴,它有助於減少頁面加載。)
dist文件夾:編譯后或者壓縮后的代碼
src文件夾:源碼文件
assets文件夾:儲存js、css、圖片等靜態資源
static文件夾:儲存第三方靜態資源(例如jquery.js, bootstrap.css等)
注:最后編譯發布的時候會將所有的靜態資源整合到 /dist/static/ 目錄下,包括assets文件夾中的靜態資源。