Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

Commit 5143179

Browse files
author
Nicolas Schäfli
committed
Add build instructions to the readme
1 parent 43db8bb commit 5143179

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,28 @@ to not install gulp globally and use the local gulp version.
3333

3434
> local gulp can be accessed with `yarn gulp`
3535
36-
## Running the tests
36+
> Run `yarn gulp --tasks` to obtain a list of all defined tasks.
3737
38-
Run unit tests
38+
## Build
39+
### Library
40+
To build and package the library run the following command.
41+
```
42+
yarn gulp repackage
43+
```
44+
The packed library will be located at `build/distributions/npm`.
45+
46+
### Documentation
47+
The documentation is located at `./docs`.
48+
In order to build the documentation run the following command.
49+
```
50+
yarn gulp mkdocs
51+
```
52+
The html documentation will be located at `./build/docs`.
53+
54+
## Tests
55+
### Unit tests
56+
57+
All unit test can be run with the following command.
3958

4059
```
4160
yarn gulp test

0 commit comments

Comments
 (0)