github上项⽬的⽬录结构说明
jquery下载的文件怎么使用build 构建脚本
dist 编译出来的发布版
docs ⽂档
examples ⽰例⽂件
src 源码
test 测试脚本
.babelrc Babel 交叉编译的配置
.eslintrc ESLint 测试配置
.gitignore 哪些⽂件不要上传到 GitHub
.gitattributes ⽂件属性,如 EOL、是否为⼆进制等
LICENSE 授权协议
README.md ⾃述⽂件,⾥⾯⾄少得写:
项⽬的特⾊
各种 Badge ⽐如 CI 的sql唯一键语句>python怎么把全部代码加井号
怎么下载安装
⽰例运⾏/使⽤
怎么编译(尤其 C/C++,要把编译器、要装什么⼯具、依赖库全部写清楚。要带版本号!)
怎么参与
bower.json Bower 包管理器配置⽂件
package.json npm 包管理器配置⽂件
constitutional principles
曰本vs加拿大github的使⽤-⽬录解析
从github下载的项⽬⽬录,总有⼀些刚开始我们不了解⽤处的⽂件,本⽂尝试做⼀些整理归纳,希望你看了本⽂可以有所帮助,更有效率的使⽤github。
gitignore⽂件:定义不想在git中提交的⽂件
readMe:⽐较常见的项⽬说明⽂档,通常是markdown格式的,后缀为md
package.json⽂件(javaScript项⽬):定义项⽬所需要的各种模块,以及项⽬的配置信息(⽐如名称、版本、许可证等元数据)。npm install 命令根据这个配置⽂件,⾃动下载所需的模块
gruntfile.js(javaScript项⽬):
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⽂件夹中的静态资源。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论