diff --git a/README.md b/README.md index 88ce69227730d77ef204944024379f57ebfe40ca..dbf6b670110ea65931e06dfa69fc1e18b2d12279 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,23 @@ ## 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 from 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 karma tslint` -Then, you can install the necessary packages of the library: +### Install the necessary packages of the library: + +Clone or update the JalHyd project and in the JalHyd folder, run : + +`npm package` + +Then, back to the ngHyd project folder, run : + +`npm install <path to the JalHyd folder>/jalhyd-<version>.tar.gz` + +and then : `npm install` @@ -16,11 +28,11 @@ Then, you can install the necessary packages of the library: `npm run build` -### To flag suspicious language usage +### To run compilation in watch mode as well as application execution in a navigator window -`npm run lint` +`npm start` -### To run compilation in watch mode as well as application exécution in a navigator window +### To flag suspicious language usage -`npm start` +`npm run lint`