X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=5fbf87346dd57f82ba3a66ca19a9057cc153ac05;hb=17c916369498726b5dff6145a6d50261f0cb90a0;hp=7445d387e5341ee268b5efedbc37d9082291e34b;hpb=8f8f87c4fd9a0863d0aeb4a9a8671d1a2b4308e0;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 7445d387..5fbf8734 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,9 @@ Simple [node.js](https://nodejs.org/) software to simulate and scale a set of ch - [Windows](#windows) - [MacOSX](#macosx) - [GNU/Linux](#gnulinux) + - [Development prerequisites (optional)](#development-prerequisites-optional) + - [Unix](#unix) + - [Windows](#windows-1) - [Dependencies](#dependencies) - [Initial configuration](#initial-configuration) - [Start simulator](#start-simulator) @@ -70,11 +73,29 @@ brew install node #### GNU/Linux -- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for all supported versions. +- [NodeSource](https://github.com/nodesource/distributions) node.js binary distributions for all supported versions. -#### Dependencies +### Development prerequisites (optional) -Enable corepack if not already done and install latest pnpm version: +Install [volta](https://volta.sh/) for managing automatically the node.js runtime and package manager version: + +#### Unix + +```shell +curl https://get.volta.sh | bash +``` + +#### Windows + +```powershell +choco install volta +``` + +Setup [volta](https://volta.sh/) for [pnpm](https://github.com/pnpm/pnpm) package manager support: https://docs.volta.sh/advanced/pnpm + +### Dependencies + +Enable corepack, if [volta](https://volta.sh/) is not installed and configured, and install latest pnpm version: ```shell corepack enable @@ -580,6 +601,7 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`. `status`: 'success' | 'failure', `state`: { `version`: string, + `configuration`: ConfigurationData, `started`: boolean, `templateStatistics`: Record }