Skip to content

Commit

Permalink
docs: document volta usage for development
Browse files Browse the repository at this point in the history
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
  • Loading branch information
jerome-benoit committed Jun 18, 2024
1 parent 12c0935 commit 17c9163
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 17c9163

Please sign in to comment.