You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by ma...@apache.org on 2016/01/15 02:52:31 UTC

[2/8] lucy-clownfish git commit: Generalize INSTALL for multiple hosts.

Generalize INSTALL for multiple hosts.

Don't enumerate available host languages; instead refer to $LANG and
"language of choice".


Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/ed2aa84b
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/ed2aa84b
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/ed2aa84b

Branch: refs/heads/master
Commit: ed2aa84b2d30b25ddea8fc8a32ca5f4e6ec903ce
Parents: c38a4db
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Wed Dec 30 16:11:18 2015 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Wed Dec 30 16:11:18 2015 -0800

----------------------------------------------------------------------
 INSTALL.md | 31 +++++++++++--------------------
 1 file changed, 11 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ed2aa84b/INSTALL.md
----------------------------------------------------------------------
diff --git a/INSTALL.md b/INSTALL.md
index 75c0a2c..56b5f60 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,33 +1,24 @@
 Build Instructions
 ==================
 
-The Apache Clownfish "symbiotic" object system pairs with "host" dynamic
-language environments and facilitates the development of high performance host
-language extensions.  Currently, it is available for Perl and plain C
-libraries.
+Apache Clownfish consists of two parts, the Clownfish compiler "CFC" and the
+Clownfish runtime.
 
 Apache Clownfish runtime
 ------------------------
 
-To build the Clownfish runtime for Perl, chdir to the "runtime/perl"
-subdirectory underneath the "clownfish" top level and follow the instructions
-in the INSTALL document there.
+To build the Clownfish runtime, chdir into the `runtime/$LANG` subdirectory,
+where `$LANG` is your programming language of choice, and follow the
+instructions in the `INSTALL` document there.
 
-To build the Clownfish runtime for C, chdir to the "runtime/c" subdirectory
-underneath the "clownfish" top level and follow the instructions in the
-INSTALL document there.
-
-The Clownfish runtime build requires the Clownfish compiler and will build it
-first.
+The Clownfish runtime build requires the Clownfish compiler.  Some host
+language bindings will build it first automaticaly, while others require
+manual installation of the compiler as a prerequisite.
 
 Apache Clownfish compiler
 -------------------------
 
-To only build the Clownfish compiler with Perl bindings, chdir to the
-"compiler/perl" subdirectory underneath the "clownfish" top level and follow
-the instructions in the INSTALL document there.
-
-To only build the Clownfish compiler "cfc" executable, chdir to the
-"compiler/c" subdirectory underneath the "clownfish" top level and follow the
-instructions in the INSTALL document there.
+To build only the Clownfish compiler, chdir into the `compiler/$LANG`
+subdirectory, where `$LANG` is your programming language of choice, and follow
+the instructions in the `INSTALL` document there.