test: add ConfigurationData enums tests
[e-mobility-charging-stations-simulator.git] / README.md
index 063c839d6d6ac599ec9bd83fa1930a41e99924dc..183c3329c4afac812eb840013961747b8ade2bac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,13 +24,16 @@ 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)
 - [Start Web UI](#start-web-ui)
 - [Configuration files syntax](#configuration-files-syntax)
   - [Charging stations simulator configuration](#charging-stations-simulator-configuration)
-  - [Charging station configuration template](#charging-station-configuration-template)
+  - [Charging station template configuration](#charging-station-template-configuration)
   - [Charging station configuration](#charging-station-configuration)
 - [Docker](#docker)
 - [OCPP-J commands supported](#ocpp-j-commands-supported)
@@ -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/) with [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
@@ -160,7 +181,7 @@ But the modifications to test have to be done to the files in the build target d
 - **dynamicPool** (experimental):
   Dynamically sized worker pool executing a fixed total number of simulated charging stations
 
-### Charging station configuration template
+### Charging station template configuration
 
 **src/assets/station-templates/\<name\>.json**: