From 0072f9dfb0cedfc92b0a8831d5f6680d4710bc85 Mon Sep 17 00:00:00 2001 From: "francois.grand" <francois.grand@irstea.fr> Date: Tue, 27 Jun 2017 18:21:55 +0200 Subject: [PATCH] =?UTF-8?q?-=20MAJ=20du=20readme=20(2=C3=A8me=20prise)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 888bf92b..9bd0498e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## All the things to know for developping the library -The library needs nodeJS installed and the following node packages installed globally: typescript, karma, tslint. This can be done by the command line: +The library needs nodeJS installed and the following node packages installed globally: typescript, karma, tslint. This can be done from the command line: `npm install -g typescript` @@ -10,17 +10,27 @@ Then, you can install the necessary packages of the library: `npm install` -### For compiling the typescript code +### To compile the typescript code `npm run build` -### For compiling and testing the code with karma +### To compile the typescript unit tests -`npm test` +`npm run buildspec` -### For flagging suspicious language usage +### To compile and test code with jasmine + +`npm jasmine` + + +### To compile and test code with karma + +`npm karma` + + +### To flag suspicious language usage `npm run lint` @@ -29,9 +39,9 @@ Then, you can install the necessary packages of the library: The tsviz package can be used for drawing class diagram of the current code. -For installing tsviz: `npm install -g tsviz` +To install tsviz: `npm install -g tsviz` There's currently a bug on debian like distribution due to a wrong declaration of graphviz path in the code: https://github.com/joaompneves/tsviz/issues/5 To work around, you can create a link to the good path: `sudo ln -s /usr/bin/dot /usr/local/bin/dot` -For drawing the diagram: `npm run viz` +To draw the diagram: `npm run viz` -- GitLab