Update build instructions
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/931b4909 Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/931b4909 Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/931b4909 Branch: refs/heads/master Commit: 931b4909bb624d90371c0b1d552314dbe18a322e Parents: 1612e7a Author: Nick Wellnhofer <wellnho...@aevum.de> Authored: Fri Feb 3 22:33:09 2017 +0100 Committer: Nick Wellnhofer <wellnho...@aevum.de> Committed: Sat Feb 4 18:13:34 2017 +0100 ---------------------------------------------------------------------- compiler/c/INSTALL.md | 57 ++++++++++++++++++++++++------------- runtime/c/INSTALL.md | 71 ++++++++++++++++++++++++++++++++-------------- 2 files changed, 87 insertions(+), 41 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/931b4909/compiler/c/INSTALL.md ---------------------------------------------------------------------- diff --git a/compiler/c/INSTALL.md b/compiler/c/INSTALL.md index 17ba47a..1774a45 100644 --- a/compiler/c/INSTALL.md +++ b/compiler/c/INSTALL.md @@ -8,41 +8,58 @@ Building under UNIX and derivatives or Cygwin $ make $ make test +Use the installation script of the Clownfish runtime to install. + Building under Windows ---------------------- -You need MSVC or gcc as C compiler and nmake or mingw32-make as make utility. +You need MSVC or gcc as C compiler and nmake, mingw32-make, or standard +GNU make as make utility. -When using cmd.exe configure with: +Configure under cmd.exe: - $ configure.bat + configure.bat -When using the MSYS shell configure with: +Configure under a POSIX shell like MSYS: - $ ./configure + ./configure + +Build with nmake: -When building with nmake run: + nmake + nmake test - $ nmake - $ nmake test +Build with standard GNU make: -When building with mingw32-make run: + make + make test - $ mingw32-make - $ mingw32-make test +Build with mingw32-make: + + mingw32-make + mingw32-make test Configuration ------------- - ./configure [ options ] [ -- cflags ] + [ environment ] ./configure [ options ] [ -- cflags ] + +### Options + +- `--enable-coverage` + + Enable code coverage. Create HTML pages with coverage data using + lcov by running "make coverage". + +- `--with-system-cmark` + + The Clownfish compiler is built with a bundled version of libcmark + by default. Use this option if you want to link against the system + libcmark. + +### Environment variables -Options include +- `CC` - --enable-coverage - Enable code coverage. Create HTML pages with coverage data using - lcov by running "make coverage". + The C compiler. - --with-system-cmark - The Clownfish compiler is built with a bundled version of libcmark - by default. Use this option if you want to link against the system - libcmark. http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/931b4909/runtime/c/INSTALL.md ---------------------------------------------------------------------- diff --git a/runtime/c/INSTALL.md b/runtime/c/INSTALL.md index 5566b50..21aee4b 100644 --- a/runtime/c/INSTALL.md +++ b/runtime/c/INSTALL.md @@ -4,43 +4,72 @@ Build instructions for the Clownfish C library Building under UNIX and derivatives or Cygwin --------------------------------------------- - $ ./configure - $ make - $ make test + ./configure + make + make test + ./install.sh --prefix [ install prefix ] Building under Windows ---------------------- -You need MSVC or gcc as C compiler and nmake or mingw32-make as make utility. +You need MSVC or gcc as C compiler and nmake, mingw32-make, or standard +GNU make as make utility. -When using cmd.exe configure with: +Configure under cmd.exe: - $ configure.bat + configure.bat -When using the MSYS shell configure with: +Configure under a POSIX shell like MSYS: - $ ./configure + ./configure -When building with nmake run: +Build with nmake: - $ nmake - $ nmake test + nmake + nmake test -When building with mingw32-make run: +Build with standard GNU make: - $ mingw32-make - $ mingw32-make test + make + make test + +Build with mingw32-make: + + mingw32-make + mingw32-make test + +Install under cmd.exe: + + install.bat --prefix [ install prefix ] + +Install under a POSIX shell like MSYS: + + ./install.sh --prefix [ install prefix ] Configuration ------------- - ./configure [ options ] [ -- cflags ] + [ environment ] ./configure [ options ] [ -- cflags ] + +### Options + +- `--enable-coverage` + + Enable code coverage. Create HTML pages with coverage data using + lcov by running "make coverage". + +- `--disable-threads` + + Disable thread support. + +### Environment variables + +- `CC` + + The C compiler. -Options include +- `TARGET_CC` - --enable-coverage - Enable code coverage. Create HTML pages with coverage data using - lcov by running "make coverage". - --disable-threads - Disable thread support. + The target compiler when cross-compiling. `CC` can be set in addition + to specify the host compiler.
