From: Jérôme Benoit Date: Tue, 18 Jun 2024 17:28:15 +0000 (+0200) Subject: docs: document volta usage for development X-Git-Tag: v1.3.7~41 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=17c916369498726b5dff6145a6d50261f0cb90a0;p=e-mobility-charging-stations-simulator.git docs: document volta usage for development Signed-off-by: Jérôme Benoit --- diff --git a/README.md b/README.md index 063c839d..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