Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Removes $ before commands for better copy paste experience.
  • Loading branch information
mktcode authored Jan 19, 2024
1 parent c04cf11 commit d53e8a6
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.
First, you need to install the dependencies:

```sh
$ bun install
bun install
```

Then, you need to set up all the required
Expand All @@ -83,7 +83,7 @@ To assist with the setup process, run `bunx hardhat vars setup`. To set a partic
variable, execute this:

```sh
$ bunx hardhat vars set MNEMONIC
bunx hardhat vars set MNEMONIC
? Enter value: ‣ here is where your twelve words mnemonic should be put my friend
```

Expand All @@ -94,71 +94,71 @@ If you do not already have a mnemonic, you can generate one using this [website]
Compile the smart contracts with Hardhat:

```sh
$ bun run compile
bun run compile
```

### TypeChain

Compile the smart contracts and generate TypeChain bindings:

```sh
$ bun run typechain
bun run typechain
```

### Test

Run the tests with Hardhat:

```sh
$ bun run test
bun run test
```

### Lint Solidity

Lint the Solidity code:

```sh
$ bun run lint:sol
bun run lint:sol
```

### Lint TypeScript

Lint the TypeScript code:

```sh
$ bun run lint:ts
bun run lint:ts
```

### Coverage

Generate the code coverage report:

```sh
$ bun run coverage
bun run coverage
```

### Report Gas

See the gas usage per unit test and average gas per method call:

```sh
$ REPORT_GAS=true bun run test
REPORT_GAS=true bun run test
```

### Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

```sh
$ bun run clean
bun run clean
```

### Deploy

Deploy the contracts to Hardhat Network:

```sh
$ bun run deploy:contracts
bun run deploy:contracts
```

### Tasks
Expand All @@ -168,7 +168,7 @@ $ bun run deploy:contracts
Deploy a new instance of the Lock contract via a task:

```sh
$ bun run task:deployLock --unlock 100 --value 0.1
bun run task:deployLock --unlock 100 --value 0.1
```

### Syntax Highlighting
Expand All @@ -188,13 +188,13 @@ on/off.
### Install Ganache

```sh
$ npm i -g ganache
npm i -g ganache
```

### Run a Development Blockchain

```sh
$ ganache -s test
ganache -s test
```

> The `-s test` passes a seed to the local chain and makes it deterministic
Expand Down

0 comments on commit d53e8a6

Please sign in to comment.