From 03e09e6caa5d1923685f2e82d3d984390e71786d Mon Sep 17 00:00:00 2001 From: youen Date: Sat, 2 Oct 2021 11:49:52 +0100 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c130d4d..9c30869 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # vhelio-simulator -Vehicle energy consumption and production simulator \ No newline at end of file +Vehicle energy consumption and production simulator. This tool has been created by [Vélo solaire pour tous](https://vhelio.org/association/) for simulating the `vhélio` behavior, but is designed to be easy to adapt to other vehicles. + +## Using the simulator + +The easiest way is to use the [online simulator](https://vhelio.org/simulateur-vhelio/). + +You can also download the latest pre-built stand-alone version and open `www/vhelio-simulator.html` in your web browser. The program will run in your browser, but won't communicate with any server, this is a purely local application. + +## Building from source + +### Dependencies + +The simulator is written in `typescript`, whose compiler depends on `node.js`. + +The first step is to [install node.js](https://nodejs.org) + +Then go in the `simulator` folder and run this command: `npm install`. This will install all the npm modules listed in `package.json`, including the `typescript` compiler. + +### Build + +Execute `build.sh` on Linux, or `build.bat` on Windows. + +That's it, you can now open `www/vhelio-simulator.html` in your browser.