Skip to content

Commit e2c9c90

Browse files
authored
Be clearer about testrpc-sc / network config
1 parent 4705bf8 commit e2c9c90

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,11 @@ $ npm install --save-dev solidity-coverage
2121
```
2222

2323
### Run
24-
24+
Set a `coverage` network in truffle-config.js (see [Network Configuration](#network-configuration)) and then run:
2525
```
2626
$ npx solidity-coverage
2727
```
2828

29-
**NB:** Most projects will also need to set a `coverage` network in
30-
truffle-config.js. See [Network Configuration](#network-configuration).
31-
3229
### Usage notes:
3330
+ For pragma solidity >=0.4.22 <0.6.0 / Petersburg / Truffle v4 and v5
3431
+ Tests run more slowly while coverage is being generated.
@@ -41,7 +38,9 @@ a local dependency, please see [this section](https://github.com/sc-forks/solidi
4138
### Network Configuration
4239

4340
By default, this tool connects to a coverage-enabled fork of ganache-cli
44-
called **testrpc-sc** on port 8555. (It's a dependency - there's nothing extra to download.)
41+
called **testrpc-sc** on port 8555.
42+
+ it's a dependency - there's nothing extra to download.
43+
+ the solidity-coverage command launches it automatically in the background. (See [this section of the FAQ](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-testrpc-sc-on-its-own) if you need to launch it separately yourself)
4544

4645
In `truffle-config.js`, add a coverage network following the example below.
4746

0 commit comments

Comments
 (0)