Skip to content

Commit

Permalink
Update README.md with instructions to use remappings (#14)
Browse files Browse the repository at this point in the history
Lohann authored Sep 13, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent d9fe295 commit 00090ef
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -25,6 +25,17 @@ cd hello_gmp
forge install Analog-Labs/analog-gmp
```

### Solidity file remappings
1. To map the imports to the correct files, run the following command to create the `remmaping.txt` file in the project root directory:
```sh
forge remappings > remappings.txt
```
obs: is important to run the command above only after install all dependecies.

2. (optional) if you are using vscode, follow the instructions here:
- https://book.getfoundry.sh/config/vscode?highlight=remappin#2-dependencies

### Import analog-gmp dependencies
All setup! now just need to import gmp dependencies from `@analog-gmp`:
```solidity
import {IGmpReceiver} from "@analog-gmp/interfaces/IGmpReceiver.sol";

0 comments on commit 00090ef

Please sign in to comment.