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 包管理器配置文件
---------------------css
github的使用-目錄解析前端
從github下載的項目目錄,總有一些剛開始咱們不瞭解用處的文件,本文嘗試作一些整理概括,但願你看了本文能夠有所幫助,更有效率的使用github。java
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文件夾中的靜態資源。jquery