Skip to content

Commit

Permalink
update README to Makefile instructions (#757)
Browse files Browse the repository at this point in the history
* update README to Makefile instructionys

* update lint section
  • Loading branch information
sentilesdal authored Feb 9, 2024
1 parent 28a8a24 commit ab0460f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,18 @@ provider URLs.

## Build

To build the smart contracts, run `yarn build`.
To build the smart contracts, run `make build`.

## Test

To test the smart contracts, run `yarn test`.
To test the smart contracts, run `make test`.

## Lint

We have several linters. Solhint is a Solidity linter that checks for best
practices and style, prettier is a Solidity formatter that checks for formatting
and style, and cSpell is a spell checker. To run all three, run `yarn lint`.
If you want to automatically format the code, run `yarn prettier`.
and style, and cSpell is a spell checker. To run all three, run `make lint`.
If you want to automatically format the code, run `make prettier`.

## Yield Sources

Expand Down

0 comments on commit ab0460f

Please sign in to comment.