[add] readme
This commit is contained in:
parent
51431ec4cf
commit
4d17055498
26
readme.md
Normal file
26
readme.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# Composition
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- Typescript compiler (Debian package name: `node-typescript`)
|
||||||
|
- GNU Make (Debian package name: `make`)
|
||||||
|
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
- execute `tools/build`
|
||||||
|
|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
### Requirement
|
||||||
|
|
||||||
|
- NodeJS (Debian package name: `nodejs`)
|
||||||
|
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
- execute `build/mixin`
|
||||||
|
|
Loading…
Reference in a new issue