Skip to content
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

Jump to bottom

fix: specify range of node versions in readme and advise cd into package #535

Merged
merged 2 commits into from
Feb 14, 2024
Merged

fix: specify range of node versions in readme and advise cd into package #535

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccf0eea
fix: specify range of node versions in readme and advise cd into package
terrylovesyoghurt Feb 12, 2024
d41a122
turned nvm to a suggestion
terrylovesyoghurt Feb 12, 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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,15 @@ Please do not use the issue tracker for security issues.

## Setup

Ensure you have Node and Yarn installed.

The latest Node version officially supported by OSx and Hardhat is 16. Node >=19 also works, but is technically unsupported by Hardhat. It's recommended to use a tool such as [nvm](https://github.com/nvm-sh/nvm) to manage different node environments. Please see the relevant documentation for details.

Start by running `yarn install` in the project root in your terminal.

### Dependencies

Since the repo is set up as yarn workspace, all the linking is done automatically.
Since the repo is set up as yarn workspace, all the linking is done automatically. When contributing, we recommend to `cd` into each package, as this mirrors the workflow of the development team.

## How the Aragon OSx protocol works

Expand Down
Loading