diff --git a/README.md b/README.md index 888bf92b83a0bdc325f52825f21dd8274c89f924..9bd0498ef799509472d0267456060a6a473c2dac 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`