From 07b29277e95aa1c0c7628fea80bded16d0e23764 Mon Sep 17 00:00:00 2001 From: Evan Simkowitz Date: Thu, 2 May 2024 14:35:10 -0700 Subject: [PATCH] Update build documentation to reflect that Corepack is needed (#641) --- BUILD.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/BUILD.md b/BUILD.md index 820b9573..35c43b9b 100644 --- a/BUILD.md +++ b/BUILD.md @@ -24,8 +24,15 @@ brew install scripthaus You also need a relatively modern nodejs with npm and yarn installed. -- Node can be installed from [https://nodejs.org](https://nodejs.org). -- npm can install yarn using: +Node can be installed from [https://nodejs.org](https://nodejs.org). + +We use Yarn Modern to manage our packages. The recommended way to install Yarn Modern is using Corepack, a new utility shipped by NodeJS that lets you manage your package manager versioning as you would any packages. + +If you installed NodeJS from the official feed (via the website or using NVM), this should come preinstalled. If you use Homebrew or some other feed, you may need to manually install Corepack using `npm install -g corepack`. + +For more information on Corepack, check out [this link](https://yarnpkg.com/corepack). + +Once you've verified that you have Corepack installed, run the following script to set up Yarn for the repository: ```sh corepack enable