diff --git a/README.md b/README.md index d9a588a4..a6f076e4 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ This documentation comprises these three parts: * [Why do we need yet another C++ Test Framework?](docs/why-catch.md) * [Tutorial](docs/tutorial.md) - getting started * [Reference section](docs/Readme.md) - all the details +* [Node.js/npm support](docs/nodejs-npm.md) - how to use with Node.js, node-gyp, and npm ## More * Issues and bugs can be raised on the [Issue tracker on GitHub](https://github.com/philsquared/Catch/issues) diff --git a/docs/nodejs-npm.md b/docs/nodejs-npm.md new file mode 100644 index 00000000..d64302ad --- /dev/null +++ b/docs/nodejs-npm.md @@ -0,0 +1,60 @@ +# Catch on npm + +This document describes how use to Catch with [node-gyp](https://github.com/nodejs/node-gyp) for [Node.js](https://github.com/nodejs/node) applications. Thanks to @philsquared and Catch contributors for the library, and @smikes for the foundation of the npm/node-gyp stuff! + +# Using catch via npm + +A `package.json` is provided for installation with [npm](https://github.com/npm/npm). NB: as of this writing (2016-09-21) the `catch` npm package refers to @smikes's original work which uses an older version of Catch. You can use `@bchociej/catch` for this version. + + +# Settings in binding.gyp + +`include_dirs` should reference the Catch include directory: + + "include_dirs": [ + "" + ], + "license": "Boost", + "bugs": { + "url": "https://github.com/bchociej/Catch/issues" + }, + "homepage": "https://github.com/bchociej/Catch" +}