You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by nw...@apache.org on 2014/01/14 22:34:10 UTC

[lucy-commits] [03/12] git commit: Installation instructions

Installation 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/70324010
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/70324010
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/70324010

Branch: refs/heads/master
Commit: 703240109ed5af629494a807536e5a1c375d9076
Parents: b14e405
Author: Nick Wellnhofer <we...@aevum.de>
Authored: Tue Jan 14 21:58:52 2014 +0100
Committer: Nick Wellnhofer <we...@aevum.de>
Committed: Tue Jan 14 22:18:21 2014 +0100

----------------------------------------------------------------------
 INSTALL               | 33 +++++++++++++++++++++++++++++++++
 compiler/perl/INSTALL | 15 +++++++++++++++
 2 files changed, 48 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/70324010/INSTALL
----------------------------------------------------------------------
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..41034e9
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,33 @@
+Build Instructions
+==================
+
+Clownfish is a "symbiotic" object system for C which is designed to pair with
+a "host" dynamic language environment, facilitating the development of high
+performance host language extensions.  Currently it is available for Perl and
+plain C libraries.
+
+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 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.
+
+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.
+

http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/70324010/compiler/perl/INSTALL
----------------------------------------------------------------------
diff --git a/compiler/perl/INSTALL b/compiler/perl/INSTALL
new file mode 100644
index 0000000..77823b0
--- /dev/null
+++ b/compiler/perl/INSTALL
@@ -0,0 +1,15 @@
+Installing the Clownfish compiler with Perl bindings
+====================================================
+
+To install the Clownfish compiler as a suite of Perl modules, run the
+following commands:
+
+    perl Build.PL
+    perl Build
+    perl Build test
+    perl Build install
+
+Module::Build is required.  Since Perl 5.10.0, Module::Build has been bundled
+with the Perl core, but on older systems it may be necessary to install it
+from CPAN first.
+