Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanJCasey authored Dec 22, 2023
1 parent 7478490 commit 4ec1b09
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ Please **DO NOT** open a public issue.

## Using this Repository

This repository has been migrated from Hardhat to Foundry. All production contracts continue to live in `contracts/persistent/` and `contracts/release/` (deployed contracts [here](https://docs.enzyme.finance/developers/contracts)).
This is the branch for active development, and it contains:

If you are looking for the legacy test suite & test coverage please refer to the [hardhat branch](https://github.com/enzymefinance/protocol/tree/hardhat).
1. Not fully audited: work-in-progress system contracts changes
2. Audited and in-use: "plugin" contracts (e.g., integrations, price feeds, policies, fees) and peripheral contracts (e.g., wrappers) that are backwards-compatible with v4.

For deployed, in-production system contracts, see the relevant release branch (e.g., `v4`).

v4 contract deployments can be found [here](https://docs.enzyme.finance/developers/contracts).

### Prerequisites

Expand Down Expand Up @@ -72,6 +77,12 @@ You can also manually run parts of the test suite using `forge` directly, e.g:
forge test --match-test <REGEX>
```

#### Hardhat test coverage

This repository has been migrated from Hardhat to Foundry, and old test suites are still being ported.

If you are looking for the legacy test suite & test coverage please refer to the [hardhat branch](https://github.com/enzymefinance/protocol/tree/hardhat).

## Contributing

See [our contributing instructions](.github/CONTRIBUTING.md).
Expand Down

0 comments on commit 4ec1b09

Please sign in to comment.