UNPKG

fire-keeper/readme.md

Version:

623 BMarkdownView Raw

1# Fire Keeper
2
3一个简单的项目构建工具。
4
5## 安装
6
7```shell
8npm install --save-dev fire-keeper
9```
10
11## 使用
12
13首先，在代码中引入模块。
14
15```coffeescript
16$ = require 'fire-keeper'
17```
18
19之后就可以愉快地玩耍啦。
20
21```coffeescript
22$.task 'build', -> await $.compile_ './source/index.coffee', './'
23```
24
25## 方法
26
27注意，以`_`结尾的方法均为`async function`，需要加`await`调用。
28
29详情请查阅[文档](./doc/index.md)。
30
31## 编译
32
33```shell
34gulp build
35```
36
37## 测试
38
39```shell
40gulp test
41```
42
43## 注意
44
45该项目**可能并不稳定**。
46
47**最后更新于`2019/7/30`。**

1	`# Fire Keeper`
2
3	`一个简单的项目构建工具。`
4
5	`## 安装`
6
7	```shell
8	`npm install --save-dev fire-keeper`
9	```
10
11	`## 使用`
12
13	`首先，在代码中引入模块。`
14
15	```coffeescript
16	`$ = require 'fire-keeper'`
17	```
18
19	`之后就可以愉快地玩耍啦。`
20
21	```coffeescript
22	`$.task 'build', -> await $.compile_ './source/index.coffee', './'`
23	```
24
25	`## 方法`
26
27	注意，以`_`结尾的方法均为`async function`，需要加`await`调用。
28
29	`详情请查阅[文档](./doc/index.md)。`
30
31	`## 编译`
32
33	```shell
34	`gulp build`
35	```
36
37	`## 测试`
38
39	```shell
40	`gulp test`
41	```
42
43	`## 注意`
44
45	`该项目可能并不稳定。`
46
47	最后更新于`2019/7/30`。