github上项目的目录结构说明
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文件夹中的静态资源。