From 69e0813cf7f3667bea4760e79cbeb45772a43157 Mon Sep 17 00:00:00 2001
From: Mark Pictor <mpictor@gmail.com>
Date: Thu, 23 Feb 2012 17:41:11 -0500
Subject: [PATCH] improve installation instructions

---
 INSTALL | 41 ++++++++++++++++++++++++++++-------------
 README  | 46 +---------------------------------------------
 2 files changed, 29 insertions(+), 58 deletions(-)

diff --git a/INSTALL b/INSTALL
index 9d8ac46a..1993de1e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -21,20 +21,22 @@ Installation
 * Build system uses CMake now: configure, Makefile, and all
   autotools files have been removed, as has mkProbe.
 
-* To build on Linux or OSX:
-  cd scl
-  mkdir build
-  cd build
-  cmake ..
-  make
+* Building SCL from the command prompt:
+  - cd scl
+  - mkdir build
+  - cd build
+  - cmake ..
+  - make
+  - make install       #  optional
 
-* To build on windows:
-  Run cmake-gui, set it to build in scl/build
-  Select the correct build file generator
-  Press Configure
-  Change options as necessary, configuring again afterwards
-  Press Generate
-  Open the main build file using your preferred build tool
+* Building SCL from the GUI:
+  - Run cmake-gui, set it to build in scl/build
+  - Select the correct build file generator
+  - Press Configure
+  - Change options as necessary, configuring again afterwards
+      -  If there are errors, some options may not be visible until the error is resolved
+  - Press Generate
+  - Open the main build file using your preferred build tool
 
 * Build options (append to the 'cmake ..' line):
   -DBUILD_SCHEMAS="path/to/schema.exp;path/to/schema2.exp"
@@ -53,3 +55,16 @@ Installation
   -DCMAKE_BUILD_TYPE=Release
     - this causes binaries to be built without debugging information
     - without this, cmake defaults to a Debug build
+
+* Using CTest to test SCL:
+  - Read the comments in run_ctest.cmake
+  - (OPTIONAL) Create scl/../.SCL_CTEST_PREFS.cmake, and set variables
+    in it (this file is required for CDash submission to be enabled)
+  - Run tests with `ctest -S run_ctest.cmake`
+
+* Using CTest to regenerate the schema matrix on the github SCL wiki:
+  - Requires:
+     - git
+     - python
+     - a clone of the git repo for the wiki at scl/../wiki-scl
+  - run `ctest -S ctest_matrix.cmake`
diff --git a/README b/README
index ce0972f0..08ccd5ce 100644
--- a/README
+++ b/README
@@ -19,51 +19,7 @@ Step Class Library v0.5 -- http://github.com/mpictor/StepClassLibrary
 * Build system uses only CMake now: configure, Makefile, and all
   autotools files have been removed, as has mkProbe.
   
-* To build on Linux or OSX:
-  cd scl
-  mkdir build
-  cd build
-  cmake ..
-  make
-
-* To build on windows:
-  Run cmake-gui, set it to build in scl/build
-  Select the correct build file generator
-  Press Configure
-  Change options as necessary, configuring again afterwards
-  Press Generate
-  Open the main build file using your preferred build tool
-  
-* Build options (append to the 'cmake ..' line):
-  -DBUILD_SCHEMAS="path/to/schema.exp;path/to/schema2.exp" 
-    - this generates c++ for the schema, and compiles it into a
-      library. Also works with directories, as long as each dir only
-      has one express file.
-    - multiple files/directories are separated by semicolons
-    - this also builds a 'p21read' program, which reads one step file
-      and writes another. It may change whitespace or remove comments;
-      otherwise, the input and output files should be identical. If
-      they are not identical, either the file does not match the
-      schema, or SCL generated incorrect source code.
-   -DBUILD_SCHEMAS=ALL
-    - Added to make use of ctest easier. If BUILD_SCHEMAS == ALL,
-      then CMake adds each *.exp file found in data/.
-  -DCMAKE_BUILD_TYPE=Release
-    - this causes binaries to be built without debugging information
-    - without this, cmake defaults to a Debug build
-
-* Using CTest to test SCL:
-  - Read the comments in run_ctest.cmake
-  - (OPTIONAL) Create scl/../.SCL_CTEST_PREFS.cmake, and set variables
-    in it (this file is required for CDash submission to be enabled)
-  - Run tests with `ctest -S run_ctest.cmake`
-
-* Using CTest to regenerate the schema matrix on the github SCL wiki:
-  - Requires:
-     - git
-     - python
-     - a clone of the git repo for the wiki at scl/../wiki-scl
-  - run `ctest -S ctest_matrix.cmake`
+* Building and testing SCL - see the INSTALL file
 
 ***********************************************************************