Commits

Matt Oswald committed 7807591

adding install/setup directions

  • Participants
  • Parent commits eacb45f

Comments (0)

Files changed (2)

 == About xUnit++ ==
 xUnit++ borrows heavily from xUnit.net, which means it has the same strengths. It is built to support Test Driven Development, with a goal of being as simple and flexible as possible without sacrificing features found in modern unit testing platforms written for other languages (such as C#). It is compatible with Visual Studio 2012 (and includes integration with the IDE's test explorer window) and gcc (tested on Ubuntu Linux).
 
-=== Quick Look ===
+== Quick Look ==
 Let's look at a simple example:
 {{{
 #!c++

File InstallAndSetup.wiki

+== Installation and Setup ==
+
+There are two avenues to including xUnit++ in your project:
+
+* Clone the project somewhere.
+* Download and unpack the latest official release.
+
+==== Source Install ====
+
+* When including the full source of xUnit++ within your project, it is recommended that you include it somewhere within your project's tree. This way you can keep your version of xUnit++ synchronized with your project.
+
+{{{
+hg clone ssh://hg@bitbucket.org/moswald/xunit path_to/project_root/external/xUnit++
+}}}
+
+* Add the xUnit++/xUnit++ library to your build process (either xUnit++/xUnit++/xUnit++.vcxproj for Visual Studio or xUnit++/xUnit++/SConstruct for SCons).
+* Create a shared object library project (.dll or .so) to store your tests.
+* Modify your test project's include path to include {{{xUnit++/xUnit++}}}.
+* Modify your test project's link settings to include {{{xUnit++/bin/xUnit++/<Configuration>/<Platform>/xUnit++.lib}}}.
+* Optionally (but recommended), include the xUnit++.console project in your build, and modify your test project's build to include running your tests after every succesful build. xUnit++.console will return the number of failed tests, so you can use that return value to halt your build script.
+
+==== Packaged Release ====
+
+* Download the latest release and unpackage it somewhere within your source tree, for example {{{path_to/project_root/external/xUnit++}}}.
+* Create a shared object library project (.dll or .so) to store your tests.
+* Modify your test project's include path to include the path to {{{xUnit++/include}}}.
+* Modify your test project's link setting to include {{{xUnit++/bin/<Configuration>/<Platform>/xUnit++.lib}}}.
+* Optionally (but recommended), modify your build process to include running your test project's output, failing the build if the runner returns anything other than 0. Your platform's test runner can be found in {{{xUnit++/bin/<Configuration>/<Platform>/}}}
+
+====== Visual Studio ======
+
+Regardless of the path taken to add xUnit++ to your project, you can install the xUnit++ Visual Studio Test Adapter from [[path to visual studio adapter installer]]. This will automatically discover and run your tests for you using the built-in Text Execution Window.