More README edits

pull/393/head
cgewecke 5 years ago committed by GitHub
parent d80eb051fe
commit caa5b4bc67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 11
      README.md

@ -21,10 +21,10 @@ $ npm install --save-dev solidity-coverage
``` ```
### Usage notes: ### Usage notes:
+ For pragma solidity >=0.4.22 <0.6.0 / Petersburg + For pragma solidity >=0.4.22 <0.6.0 / Petersburg
+ Tests run more slowly while coverage is being generated. + Coverage runs tests a little more slowly.
+ Contracts consume more gas while coverage is being generated. + Coverage distorts gas consumption.
+ solidity-coverage launches its own in-process ganache instance. You can + Coverage launches its own in-process ganache instance. You can
set its [options](https://github.com/trufflesuite/ganache-core#options) via set [ganache options](https://github.com/trufflesuite/ganache-core#options) via
the `providerOptions` key in your `.solcover.js` config file. the `providerOptions` key in your `.solcover.js` config file.
### Truffle >= V5: setup and run ### Truffle >= V5: setup and run
@ -44,11 +44,12 @@ truffle run coverage [options]
### Command Options ### Command Options
| Option | Example | Description | | Option | Example | Description |
|--------------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------| |--------------|--------------------------------|-------------|
| --file | --file="test/registry/*.js" | Filename or glob describing a subset of JS tests to run. (Globs must be enclosed by quotes.)| | --file | --file="test/registry/*.js" | Filename or glob describing a subset of JS tests to run. (Globs must be enclosed by quotes.)|
| --solcoverjs | --solcoverjs ./../.solcover.js | Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed) | | --solcoverjs | --solcoverjs ./../.solcover.js | Relative path from working directory to config. Useful for monorepo packages that share settings. (Path must be "./" prefixed) |
| --version | | Version info | | --version | | Version info |
| --help | | Usage notes | | --help | | Usage notes |
|<img width=170/>|<img width=500/> |<img width=100/>|
### Config Options ### Config Options

Loading…
Cancel
Save