first commit

whtml-cli/README.md

@@ -0,0 +1,77 @@
+
+## WHtml-cli
+
+框架[WHtml](https://github.com/helpcode/Whtml)的官方cli脚手架工具，让你更加快速的创建项目，感受编码的乐趣。
+
+## 安装
+
+一行命令解决一切
+
+> npm install -g whtml-cli
+
+
+## 使用
+
+你只需要简单的输入以下几条命令即可愉快运行网站：
+
+```js
+$ whtml init project    # 创建项目 project 为你项目名字(自定义)
+$ cd project            # 进入文件
+$ npm install           # 解决依赖
+
+# 提供的命令
+
+$ npm run all           # 运行网站
+$ npm run doc           # 运行帮助手册
+$ npm run push          # 快速发布至Github，仅限Linux
+```
+
+## 开源
+
+框架的源代码已经提交`Github`，你可以从`Github`了解更多的信息: 
+
+- 1: [Whtml 源码](https://github.com/helpcode/Whtml)
+
+- 2: [Whtml 文档](https://helpcode.github.io/Whtml/#/)
+
+
+## 特性
+
+`WHtml`能够让你获得以下更加爽快的体验：
+
+---
+
+- 1: 将静态页面组件化模块化，降低重复代码的重复编写。
+
+- 2: 基于Node.js + Gulp 自动化构建项目，让前端的你无缝对接
+
+- 3: 采用jade + stylus，用更加简洁高效的方式去书写html和css
+
+- 4: 自动压缩合并编译html，css，JavaScript使的项目具备更加优秀的响应速度
+
+- 5: 更加自由的框架配置和详细的中文代码注释，一键轻松配置源码实现定制化
+
+- 6: 简洁明了的ES6+语法，代码赏心悦目，提升编码乐趣。
+
+- 7: 程序实时编译同步你的每一行修改，删除，重命名，新建为你自动构建输出到 dist/，代码写完程序自动zip压缩打包，你需要做的是将zip发给你的后端即可。
+
+- 9: ....等
+
+更多的功能期待你的切身尝试！
+
+
+## 注意
+
+- 1：请先安装`git`并确保`git`命令能在终端中正确反馈，因为`cli`脚手架需要通过`git`来安装下载代码到你的项目中。
+
+- 2：`init`下载速度是基于你的网速决定的，如果太慢不需要着急等待片刻就好。
+
+## 贡献
+
+感谢`陈尧瑞`童鞋在实际项目中的使用，并进一步提的宝贵建议。如果你正在使用本框架，并且框架为你带来了更高的效率，请帮忙转发，感谢！框架的编译速度，核心代码逻辑，功能开发等..还有很多优化的地方，你的认可是我开源动力。
+
+如果你有web框架开发经验十分欢迎交流宝贵的设计思想，同时项目将稳定持续的更新升级...
+
+## 捐赠
+
+如果你觉得 `WHtml` 对你有帮助，或者想对我微小的工作一点资瓷，欢迎给我提建议：QQ群：399041912。