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:34 UTC
[5/8] lucy-clownfish git commit: Rework top-level README and
Clownfish.md.
Rework top-level README and Clownfish.md.
Now that we have functional C and Go bindings, cast Clownfish as being
developed for multiple languages and de-emphasize Perl. Change "dynamic
languages" to "programming languages", as Go is not dynamic.
Add a "Help wanted" section and state explicitly that the target
audience for this release is developers.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/63212700
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/63212700
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/63212700
Branch: refs/heads/master
Commit: 63212700998e8fffdefdabd28d903295491c926f
Parents: d5b2474
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Wed Dec 30 16:44:55 2015 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Wed Dec 30 16:44:55 2015 -0800
----------------------------------------------------------------------
README.md | 30 +++++++++++++++++++++++++-----
runtime/core/Clownfish.md | 28 +++++++++++++++++++++++-----
2 files changed, 48 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/63212700/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 8bc4d46..1bab629 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,34 @@
Apache Clownfish
================
-OVERVIEW
+The Apache Clownfish "symbiotic" object system pairs with "host" programming
+language environments and facilitates the development of high performance
+language extensions.
-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 a subproject of Apache Lucy.
+Host language support
+---------------------
-INSTALLATION
+Bindings for the following hosts are under development:
+
+* C (feature-complete)
+* Go (experimental)
+* Perl 5 (feature-complete)
+* Python 3 / CPython (nascent)
+* Ruby / MRI (nascent)
+
+Installation
+------------
To build and install Apache Clownfish, follow the instructions in the
accompanying "INSTALL" document.
+Help wanted
+-----------
+
+The target audience for the current release of Clownfish is developers.
+Clownfish is developed by the Apache Lucy community, where it is used to
+provide host language bindings for the Lucy search engine library; we expect
+that as Clownfish matures it will eventually spin off as an independent
+project. If you would like to contribute to Clownfish, please join the [Lucy
+developers mailing list](http://lucy.apache.org/mailing_lists).
+
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/63212700/runtime/core/Clownfish.md
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish.md b/runtime/core/Clownfish.md
index 058eb12..8caa761 100644
--- a/runtime/core/Clownfish.md
+++ b/runtime/core/Clownfish.md
@@ -1,13 +1,12 @@
# Apache Clownfish symbiotic object system
-Apache 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.
+The Apache Clownfish "symbiotic" object system pairs with "host" programming
+language environments and facilitates the development of high performance
+language extensions.
## Features
-* Designed to support multiple host languages. Currently, only Perl is
- supported.
+* Support for multiple host languages.
* Support for stand-alone C libraries and executables.
* Subclassing and method overriding from the host language.
* Support for host language idioms like named parameters or default argument
@@ -52,6 +51,25 @@ The Clownfish runtime provides:
* The [](cfish.Class) metaclass.
* Some helper classes.
+## Host language support
+
+Bindings for the following hosts are under development:
+
+* C (feature-complete)
+* Go (experimental)
+* Perl 5 (feature-complete)
+* Python 3 / CPython (nascent)
+* Ruby / MRI (nascent)
+
+## Help wanted
+
+The target audience for the current release of Clownfish is developers.
+Clownfish is developed by the Apache Lucy community, where it is used to
+provide host language bindings for the Lucy search engine library; we expect
+that as Clownfish matures it will eventually spin off as an independent
+project. If you would like to contribute to Clownfish, please join the [Lucy
+developers mailing list](http://lucy.apache.org/mailing_lists).
+
## Documentation
* [Working with Clownfish classes](ClassIntro)