Skip to content

docs: updated readme with command for installing packages from source using Yarn #2447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: updated readme with command for installing packages from source using Yarn #2447

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d287382
Update Readme.md
sahanar11 Oct 27, 2024
d34b3d5
Update docs
sahanar11 Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@ By default, pre-built binaries will be downloaded if you're on one of the follow
- Linux x86/64 (glibc only)
- Windows x86/64

If you want to build from source, use `npm install --build-from-source` and see the **Compiling** section below.
If you want to build from source,

For npm, use: `npm install --build-from-source`

or with yarn, use: `npm_config_build_from_source=true yarn install`

and see the **Compiling** section below.

The minimum version of Node.js required is **18.12.0**.

Expand Down Expand Up @@ -589,7 +595,9 @@ Notes and caveats:
First make sure you've built the latest version. Get all the deps you need (see [compiling](#compiling) above), and run:

```
npm install --build-from-source
For npm, use: `npm install --build-from-source`

or with yarn, use: `npm_config_build_from_source=true yarn install`
```

For visual tests: `npm run test-server` and point your browser to http://localhost:4000.
Expand Down