lucy-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nwelln...@apache.org
Subject [lucy-commits] git commit: refs/heads/master - Improve C library build instructions
Date Sun, 02 Mar 2014 13:19:58 GMT
Repository: lucy
Updated Branches:
  refs/heads/master 51765b1f0 -> bf886c763


Improve C library build instructions


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

Branch: refs/heads/master
Commit: bf886c76353be79b151d05163752f2d32031137c
Parents: 51765b1
Author: Nick Wellnhofer <wellnhofer@aevum.de>
Authored: Sun Mar 2 14:19:11 2014 +0100
Committer: Nick Wellnhofer <wellnhofer@aevum.de>
Committed: Sun Mar 2 14:19:11 2014 +0100

----------------------------------------------------------------------
 c/INSTALL | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy/blob/bf886c76/c/INSTALL
----------------------------------------------------------------------
diff --git a/c/INSTALL b/c/INSTALL
index 90fc9dc..a92a74c 100644
--- a/c/INSTALL
+++ b/c/INSTALL
@@ -1,6 +1,31 @@
 Build instructions for the Apache Lucy C library
 ================================================
 
+Clownfish dependency
+--------------------
+
+IMPORTANT: The Apache Lucy C library depends on the Clownfish object system
+which must be built first. Please read this section, or your build will
+probably FAIL.
+
+Lucy needs the following Clownfish components:
+
+    * The command-line Clownfish compiler 'cfc'.
+    * The Clownfish header files of the Clownfish runtime.
+    * The 'libcfish' shared library.
+
+If you installed Clownfish to /usr/local or /usr on UNIX, no further action
+should be required. If you installed Clownfish to an alternate location,
+make sure to use the --clownfish-prefix configure option:
+
+    $ ./configure --clownfish-prefix=clownfish-install-dir
+
+It's also possible to build Lucy with an uninstalled Clownfish build from
+the Clownfish source directory. To setup the required environment variables,
+run the following from the lucy/c directory before configuration:
+
+    $ source ../devel/bin/setup_clownfish_env.sh clownfish-source-dir
+
 Building under UNIX and derivatives or Cygwin
 ---------------------------------------------
 
@@ -47,8 +72,3 @@ Options include
         Specify an alternative location for Clownfish if it isn't installed
         in a system directory.
 
-To build Lucy with an uninstalled Clownfish, run the following before
-configuration:
-
-    . ../devel/bin/setup_clownfish_env.sh clownfish-source-dir
-


Mime
View raw message