Skip to content

Commit fffd3e9

Browse files
authored
Update README.md to include how to initial install (#1248)
This pull request updates the project documentation to clarify the recommended way to install dependencies. It adds instructions to use Yarn 3 instead of npm due to compatibility issues with some legacy packages. Documentation improvements: * Added a new section in `README.md` explaining that dependencies should be installed using Yarn 3, and warning that `npm install` may fail because of strict peer-dependency resolution.
1 parent ae9412e commit fffd3e9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
This project provides a web component containing the Raspberry Pi Code Editor for use on other sites. Although originally bootstrapped with [Create React App](https://github.com/facebook/create-react-app), the application has been ejected so all the build scripts etc. are now in the repo.
44

5+
## Install dependencies
6+
7+
This repository uses Yarn 3 (see `package.json``packageManager`). Please install dependencies with Yarn:
8+
9+
```
10+
yarn install
11+
```
12+
13+
Using `npm install` can fail due to strict peer-dependency resolution in npm for some legacy packages in this project.
14+
515
## Environment variables
616

717
The app uses the `dotenv` package to provide access to environment variables. Copy the example file into `.env` and use this file for any other environment variables the web component may require:

0 commit comments

Comments
 (0)