Skip to content

Commit 7b68ce1

Browse files
committed
build docs and tests instructions
1 parent 4a78058 commit 7b68ce1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,3 +258,27 @@ if (navigator.mediaDevices && navigator.mediaDevices.getUserMedia) {
258258
- AR_MARKER_INFO_CUTOFF_PHASE_POSE_ERROR_MULTI
259259
- AR_MARKER_INFO_CUTOFF_PHASE_HEURISTIC_TROUBLESOME_MATRIX_CODES
260260
```
261+
262+
## Build the tests
263+
264+
You can run an automated routine to make some tests, in the main jsartoolkit5 folder just run in a console the command:
265+
266+
```
267+
npm run test
268+
```
269+
270+
Then open the tests page:
271+
272+
```
273+
http://localhost:8085/tests/index.html
274+
```
275+
276+
## Build the documentation
277+
278+
It is possible to build the api documentation, run this command in the main jsartoolkit5 folder:
279+
280+
```
281+
npm run create-doc
282+
```
283+
284+
The api documentation will be created in the **doc** folder. Navigate to the **reference** folder to view the api docs.

0 commit comments

Comments
 (0)