From 1f1bc0f9d1ad2d91da969ce52cac0133e63ca4df Mon Sep 17 00:00:00 2001
From: cgewecke <christophergewecke@gmail.com>
Date: Tue, 19 Dec 2017 16:44:43 -0800
Subject: [PATCH] Add README note about local truffle dep

---
 README.md   |  7 +++++++
 docs/faq.md | 16 ++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 8a4c208..17d3f20 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,11 @@ Tests run signficantly slower while coverage is being generated. Your contracts
 and a 1 to 2 minute delay between the end of the second compilation and the beginning of test execution
 is possible if your test suite is large. Large Solidity files can also take a while to instrument.
 
+**Important: breaking change for versions >= `0.4.3`**
++ solidity-coverage now expects a globally installed truffle in your environment / on CI. If you
+prefer to control which Truffle version your tests are run with, please see the FAQ for
+[running truffle as a local dependency](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-truffle-as-a-local-dependency).
+
 ### Network Configuration
 
 By default, solidity-coverage generates a stub `truffle.js` that accomodates its special gas needs and
@@ -98,6 +103,7 @@ Solutions to common issues people run into using this tool:
 + [Running out of time (in mocha)](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-out-of-time-in-mocha)
 + [Running on windows](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-on-windows)
 + [Running testrpc-sc on its own](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-testrpc-sc-on-its-own)
++ [Running truffle as a local dependency](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-truffle-as-a-local-dependency)
 + [Using alongside HDWalletProvider](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#using-alongside-hdwalletprovider)
 + [Integrating into CI](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#continuous-integration-installing-metacoin-on-travisci-with-coveralls)
 + [Why are asserts and requires highlighted as branch points?](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#why-has-my-branch-coverage-decreased-why-is-assert-being-shown-as-a-branch-point)
@@ -125,3 +131,4 @@ also lint your submission with `npm run lint`. Bugs can be reported in the
 + [@rudolfix](https://github.com/rudolfix)
 + [@phiferd](https://github.com/phiferd)
 + [@e11io](https://github.com/e11io)
++ [@ukstv](htpps://github.com/ukstv)
diff --git a/docs/faq.md b/docs/faq.md
index a43da8a..4da11cb 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -201,4 +201,20 @@ $ ./node_modules/ethereumjs-testrpc-sc/bin/testrpc        // v0.1.10 and below (
 $ ./node_modules/ethereumjs-testrpc-sc/build/cli.node.js  // All others (testrpc v4.0.1 +)
 ```
 
+### Running truffle as a local dependency
+
+If your project ships with Truffle as a dev dependency and expects that instance to be
+invoked when running tests, you should either set the `copyNodeModules` option to `true`
+in your`.solcover.js` config file OR (if doing so results in poor run time performance), set
+the config's `testCommand` and `compileCommand` options as below:
+
+```javascript
+compileCommand: '../node_modules/.bin/truffle compile',
+testCommand: '../node_modules/.bin/truffle test --network coverage',
+```
+
+
+
+
+