First cut

Created Tutorial (markdown)
philsquared
2010-12-28 03:53:48 -08:00
parent c84cc5b550
commit 2572a0e2e1

17
Tutorial.md Normal file

@@ -0,0 +1,17 @@
# Getting the source code
CATCH is hosted here on GitHub. If you're familiar with Git or GitHub already then you can probably skip this section.
The simplest way to get CATCH is to just download the zip or tar file. Go to the [[Source|https://github.com/philsquared/Catch]] page and hit Downloads.
Just under the Downloads button you can also find the urls for pulling the code directly using Git, if you prefer. If you plan to use CATCH within a project that is already in a Git repository you'll probably want to get CATCH as a Git submodule. This will allow you to track CATCH independently of your own project.
## Where to put it?
CATCH is header only (there are some project files and cpp files for self test in there too, at the moment - just ignore those for now. So all you need to do is drop the files somewhere reachable from your project. The simplest way is to make a folder called catch, under your project's root source folder and place them there.
The rest of this tutorial will assume that the CATCH root folder is available unqualified - but you may need to prefix it with a folder name if necessary.
# Writing tests
coming soon...