Skip to content

Commit c638121

Browse files
committed
some tips
1 parent 61a46dc commit c638121

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

packages/foundryup/README.md

+32
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,38 @@ or
1010

1111
`npm install @metamask/foundryup`
1212

13+
## Usage
14+
15+
Once installed into a package you can do `yarn bin mm-foundryup`.
16+
17+
This will install the latest version of Foundry things by default.
18+
19+
Try `yarn bin mm-foundryup --help` for more options.
20+
21+
Once you have the binaries installed, you have to figure out how to get to them.
22+
23+
Probably best to just add each as a `package.json` script:
24+
25+
```json
26+
"scripts": {
27+
"anvil": "node_modules/.bin/anvil",
28+
}
29+
```
30+
31+
Kind of weird, but it seems to work okay. You can probably use `npx anvil` in place of `node_modules/.bin/anvil`, but
32+
getting it to work in all scenarios (cross platform and in CI) wasn't straightforward. `yarn bin anvil` doesn't work
33+
in yarn v4 because it isn't a bin of `@metamask/foundryup`, so yarn pretends it doesn't exist.
34+
35+
This all needs to work.
36+
37+
---
38+
39+
You can try it here in the monorepo by running `yarn workspace @metamask/foundryup anvil`.
40+
41+
42+
1343
## Contributing
1444

1545
This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
46+
47+

0 commit comments

Comments
 (0)