From 17c916369498726b5dff6145a6d50261f0cb90a0 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Tue, 18 Jun 2024 19:28:15 +0200 Subject: [PATCH] docs: document volta usage for development MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) 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 -- 2.34.1