example: update docs to mention CHECK_INSTALL_DIR var

git-svn-id: svn+ssh://svn.code.sf.net/p/check/code/trunk@1102 64e312b2-a51f-0410-8e61-82d0ca0eb02a

diff --git a/doc/check.texi b/doc/check.texi
index 0b07405a2d10236726f760d66ad32909e3d6b87d..5cdb948d799f17927fe75fc6f7a838761148ce1b 100644 (file)
--- a/doc/check.texi
+++ b/doc/check.texi
@@ -537,7 +537,16 @@ We set up a directory structure as follows:
 The top-level @file{CMakeLists.txt} contains the configuration checks
 for avaialble libraries and types, and also defines sub-directories
 to process. The @file{cmake/FindCheck.cmake} file contains instructions
-for locating check on the system and setting up the build to use it.
+for locating Check on the system and setting up the build to use it.
+If the system does not have pkg-config installed, @file{cmake/FindCheck.cmake}
+may not be able to locate Check successfully. In this case, the install
+directory of Check must be located manually, and the following line
+added to @file{tests/CMakeLists.txt} (assuming Check was installed under
+C:\\Program Files\\check:
+
+@verbatim
+set(CHECK_INSTALL_DIR "C:/Program Files/check")
+@end verbatim
 
 Note that @code{tests} comes last, because the code should be testing
 an already compiled library.

diff --git a/doc/example/README b/doc/example/README
index 7791921b76a5322f4fae1058e7cfce6191fad6bd..f11245aa29ea67d8e4b98c1a54d6d4d2f6c7a53e 100644 (file)
--- a/doc/example/README
+++ b/doc/example/README
@@ -46,10 +46,16 @@ CMake:
 You need the following programs installed on your system:
   -- CMake 2.8
   -- Check 0.9.9
-  -- pkg-config 0.26
+  -- (pkg-config 0.26 is optional)
 
 Somewhat earlier versions of these programs might work.
 
+NOTE: If pkg-config is not installed on the system, and MSVC is being used,
+the install location of Check must be inserted manually into the
+tests/CMakeLists.txt file, by setting the variable CHECK_INSTALL_DIR
+to the install location. Look at the tests/CMakeLists.txt file for
+a commented out example.
+
 Then, do as follows for a Unix-compatible shell:
 
 $ cmake .