| 1 | About {{pkg.name}}
|
| 2 | ------
|
| 3 |
|
| 4 | ### What's This?
|
| 5 |
|
| 6 | The basic idea of {{pkg.name}} is that creating files from files.
|
| 7 |
|
| 8 | 1. Writing a meta file called [.bud file](#spec-bud-spec).
|
| 9 | 2. Running `{{pkg.name}} render` command.
|
| 10 | 3. Files will be generated!
|
| 11 |
|
| 12 | <img style="height:256px;" src="doc/images/coz-outline.jpg" height="256">
|
| 13 |
|
| 14 |
|
| 15 | ### What For?
|
| 16 |
|
| 17 | Automation. Generating files makes your project clean and maintainable.
|
| 18 |
|
| 19 | You can define a single datasource and distribute it in various forms.
|
| 20 |
|
| 21 | For example,
|
| 22 |
|
| 23 | + Generate Javascript and Python entity from database definition.
|
| 24 | + Generate Web API document and Swift client entity from json schema objects.
|
| 25 | + Generate skelton test case files from project files.
|
| 26 |
|
| 27 |
|
| 28 | ### Why This?
|
| 29 |
|
| 30 | + **Lightweight and fast**
|
| 31 | + {{pkg.name}} does nothing bud file templating, it's very fast.
|
| 32 | + **Unopinionated and flexible**
|
| 33 | + {{pkg.name}} could be used to any kind of strings files.
|
| 34 | + Bunch of options to manipulate files.
|
| 35 | + Could be used by CLI or programmatically.
|
| 36 | + **Simple and extensible**
|
| 37 | + {{pkg.name}} provides ways to customize, like registering your own template engine.
|
| 38 |
|
| 39 |
|
| 40 | |
| \ | No newline at end of file |