Skip to content

Commit

Permalink
docs: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey committed Sep 19, 2024
1 parent 3c0bfdb commit b7eabe5
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/userguides/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,27 @@ plugin:
This helps keep your secrets out of Ape!
## Base Path
Change the base path if it is different than your root.
For example, imagine a project structure like:
```
project
└── src/
└── contracts/
└── MyContract.sol
```

In this case, you want to configure Ape like:

```yaml
base_path: src
```
This way, `MyContract.vy`'s source ID will be `"contracts/Factory.vy"` and not `"src/contracts/Factory.vy"`.
Some dependencies, such as python-based ones like `snekmate`, use this structure.

## Contracts Folder

Specify a different path to your `contracts/` directory.
Expand Down

0 comments on commit b7eabe5

Please sign in to comment.