Skip to content

Commit

Permalink
docs: note need to run corepack enable
Browse files Browse the repository at this point in the history
  • Loading branch information
wincent committed Aug 31, 2023
1 parent 83133f4 commit 7e5a19a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Points of interest and areas for exploration:

Most development tasks can be completed with `yarn`:

- `corepack enable`: To ensure appropriate Yarn version selection[^once].
- `yarn build`: Performs TypeScript build (ie. `tsc --build`).
- `yarn build:clean`: Removes TypeScript build products (ie. `tsc --build --clean`).
- `yarn build:dry`: Report what would be built without making changes (ie. `tsc --build --dry`).
Expand All @@ -41,6 +42,8 @@ Most development tasks can be completed with `yarn`:
- `yarn lint`: Run TypeScript (`tsc`-powered) lints.
- `yarn test`: Run test suite using Jest.

[^once]: Needed only once per checkout.

A Make-based interface also exists for some operations:

- `make`: Performs TypeScript build (via `tsc build`) if necessary.
Expand Down

0 comments on commit 7e5a19a

Please sign in to comment.