Skip to content

Commit

Permalink
πŸ“ Better install instructions in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TheKnarf committed Feb 2, 2024
1 parent 623f53d commit 45f8944
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,23 @@

## Developer setup

- Install [fnm](https://github.com/Schniz/fnm) and use that to get the correct version of Node and Yarn in the project.
- Install [fnm](https://github.com/Schniz/fnm) and use that to get the correct version of Node in the project.

- Install Docker. We recommend to use OrbStack if you're using Mac or Windows for development, on Linux you can install Docker directly.

- Install pnpm. On macOS you can do that with `brew install pnpm`.
- Install pnpm.

On macOS using [Homebrew](https://brew.sh/) you can install dependencies by running:

```bash
brew install fnm pnpm
brew install --cask OrbStack
```

On Windows using [Chocolatey](https://chocolatey.org/) you can install dependencies by running:

```bash
choco install -y fnm pnpm
```

And then installing OrbStack manually

0 comments on commit 45f8944

Please sign in to comment.