README.md

# JaLHyd : Javascript Library For Hydraulics

## All the things to know for developping the library

The library needs nodeJS installed.

Then, you can install the necessary packages of the library: 
`npm install`


### To compile the typescript code

`npm run build`


### To generate locally installable package

`npm run package`


### To compile and test code with jasmine

`npm run jasmine`


### To compile and test code with karma

`npm run karma`


### To flag suspicious language usage

`npm run lint`


### To generate typedoc

`npm run doc`


### UML visualisation

The tsviz package can be used for drawing class diagram of the current code.

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` 

To draw the diagram: `npm run viz`

## Release policy

Use [semantic versioning](https://semver.org/).

Before releasing a new stable version, one should complete the following files
 - CHANGELOG.md
 - package.json (update `version`)

Every stable version should be tagged with both
 - a tag stating compatibility with NgHyd, of the form `nghyd_X.Y.Z`
 - the `stable` tag

The `stable` tag should be set **after** the NgHyd compatibility tag, so that `git describe` returns `stable` (latest tag).

Here are the steps to follow for an example **4.5.0** version
 - git tag -fa nghyd_4.5.0
 - git tag -fa stable
 - git push --tags --force