Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
caglacelik committed Nov 20, 2024
1 parent 4fa8610 commit 784951f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
-include .env

.PHONY: build test local-key base-sepolia-key deploy anvil
.PHONY: build test local-key base-sepolia-key deploy anvil install

# Capture the network name
network := $(word 2, $(MAKECMDGOALS))
Expand All @@ -18,6 +18,10 @@ endif
install:
forge install foundry-rs/forge-std --no-commit && forge install OpenZeppelin/openzeppelin-contracts --no-commit && forge install OpenZeppelin/openzeppelin-foundry-upgrades --no-commit && forge install OpenZeppelin/openzeppelin-contracts-upgradeable --no-commit

# Update Dependencies
update:
forge update

# Build the contracts
build:
forge clean && forge build
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ This document provides instructions for deploying contracts using Foundry.

## Quickstart

Install dependencies:

```sh
make install
```

Compile the contracts:

```sh
Expand All @@ -22,6 +16,8 @@ Run tests on forked base-sepolia:
make test
```

## Coverage

Check coverages with:

```sh
Expand All @@ -30,6 +26,8 @@ bash coverage.sh

You can see coverages under the coverage directory.

## Storage Layout

Create storage layout with:

```sh
Expand Down

0 comments on commit 784951f

Please sign in to comment.