aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-11-12 13:17:06 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2014-11-12 13:17:06 -0800
commit5a7a3e829a9a62f51bbd49e1ef4256a64d1f2493 (patch)
tree7425905e4ab2ec89b2f10306849161b8670e9893
parent6f4f4c89fa1f9413a674b8798b30b54cfa8651af (diff)
Better installation instructions.
-rw-r--r--README.md33
1 files changed, 22 insertions, 11 deletions
diff --git a/README.md b/README.md
index 501d6bc..53aa3d9 100644
--- a/README.md
+++ b/README.md
@@ -63,27 +63,36 @@ requires [cmake] and [re2c], which is used to generate `scanners.c` from
developers, since `scanners.c` can be provided in a released source
tarball.)
-On \*nix systems, you can simply `make` and `make install`. This
-calls [cmake] to create a `Makefile` in the `build` directory,
-then uses that `Makefile` to create the executable and library.
+If you have GNU make, you can simply `make`, `make test`, and `make
+install`. This calls [cmake] to create a `Makefile` in the `build`
+directory, then uses that `Makefile` to create the executable and
+library.
-Alternatively, you can use [cmake] manually. [cmake] knows how
-to create build environments for many build systems. For
-example, to create Xcode project files on OSX:
+For a more portable method, you can use [cmake] manually. [cmake] knows
+how to create build environments for many build systems. For example,
+on FreeBSD:
mkdir build
cd build
- cmake -G Xcode .. # optionally: -DCMAKE_INSTALL_PREFIX=path
- make # executable will be created as build/src/cmake
+ cmake .. # optionally: -DCMAKE_INSTALL_PREFIX=path
+ make # executable will be create as build/src/cmake
+ make test
make install
-To run tests:
+Or, to create Xcode project files on OSX:
+ mkdir build
+ cd build
+ cmake -G Xcode ..
+ make
make test
+ make install
-(Or `perl runtests.pl spec.txt build/src/cmark` or, in the cmake
-build directory, `ctest -V`.)
+Tests can also be run manually on any executable `$PROG` using:
+ perl runtests.pl spec.txt $PROG
+
+The GNU Makefile also provides a few other targets for developers.
To test the shared library via a python wrapper:
make testlib
@@ -270,6 +279,8 @@ github issues for questions and possibly open-ended discussions.
Use the [github issue tracker](http://github.com/jgm/stmd/issues)
only for simple, clear, actionable issues.
+
+
[cmake]: http://www.cmake.org/download/
[pandoc]: http://johnmacfarlane.net/pandoc/
[re2c]: http://re2c.org