Repository: lucy-clownfish Updated Branches: refs/heads/master 6b4b61d4d -> 105f76c1e
Move README etc. to .md files. * README * CONTRIBUTING * Various INSTALL documents Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/c38a4db5 Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/c38a4db5 Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/c38a4db5 Branch: refs/heads/master Commit: c38a4db56a7b780cc1ff6fad864db77754af341e Parents: 2a77280 Author: Marvin Humphrey <[email protected]> Authored: Wed Dec 30 16:07:39 2015 -0800 Committer: Marvin Humphrey <[email protected]> Committed: Wed Dec 30 16:07:39 2015 -0800 ---------------------------------------------------------------------- CONTRIBUTING | 89 ------------------------------------------- CONTRIBUTING.md | 89 +++++++++++++++++++++++++++++++++++++++++++ INSTALL | 33 ---------------- INSTALL.md | 33 ++++++++++++++++ README | 14 ------- README.md | 14 +++++++ compiler/c/INSTALL | 44 --------------------- compiler/c/INSTALL.md | 44 +++++++++++++++++++++ compiler/go/INSTALL | 20 ---------- compiler/go/INSTALL.md | 20 ++++++++++ compiler/perl/INSTALL | 15 -------- compiler/perl/INSTALL.md | 15 ++++++++ runtime/c/INSTALL | 46 ---------------------- runtime/c/INSTALL.md | 46 ++++++++++++++++++++++ runtime/go/INSTALL | 19 --------- runtime/go/INSTALL.md | 19 +++++++++ runtime/perl/INSTALL | 15 -------- runtime/perl/INSTALL.md | 15 ++++++++ 18 files changed, 295 insertions(+), 295 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/CONTRIBUTING ---------------------------------------------------------------------- diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index 10c92d9..0000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,89 +0,0 @@ -================================ -Contributing to Apache Clownfish -================================ - -MAKE A PLAN: - - Clownfish is developed by the Apache Lucy community. - - http://lucy.apache.org/ - - If you propose to make non-trivial changes to Clownfish, especially changes - to the public API, send a note to the Lucy developer's list describing your - plans: - - http://lucy.apache.org/mailing_lists.html - -GET THE CODE: - - Clownfish's codebase is available via Git from git-wip-us.apache.org. Start - by creating a clone of the repository: - - git clone https://git-wip-us.apache.org/repos/asf/lucy-clownfish.git - - There is also a mirror on Github. - - https://github.com/apache/lucy-clownfish - - Follow the instructions in INSTALL to set up your local workspace. - -MAKE CHANGES: - - Edit the source code as you see fit, then build and run tests. - - Clownfish supports continuous integration services Travis and Appveyor - to run tests under multiple host languages, host language versions, and - platforms. If you fork the Github repository, you can make these services - automatically test the changes you made in your fork. - - Please bear the following in mind: - - * All code will eventually need to be portable to multiple operating - systems and compilers. (This is a complex requirement and it should not - block your contribution.) - * All public APIs must be documented. - * Code should be formatted according to the style guidelines at - <http://wiki.apache.org/lucy/LucyStyleGuide>. - * All unit tests must pass. - * New code needs to be accompanied by new unit tests. - * Simplicity, both in terms of API and implementation, is highly valued - within the Lucy development community; the simpler the contribution, the - more quickly it can be reviewed and integrated. - -OPEN AN ISSUE: - - Clownfish uses Lucy's issue-tracker/bug-tracker installation, which runs - Atlassian JIRA. We generally use the term "issue" rather than "bug" because - not every contribution fixes a "bug". - - https://issues.apache.org/jira/browse/CLOWNFISH - - 1. Create a JIRA account for yourself and sign in. - 2. Once you have signed in, the "create new issue" link will appear. Either - use it to open a new issue or navigate to an existing one as appropriate. - 3. To attach files to an issue, use the menu command - 'More Actions > Attach Files'. - - Attaching a file to an issue causes an email notification to be sent to the - lucy-issues list signalling that a patch has arrived. Please be patient but - persistent while engaging with the Lucy committers who review and apply such - patches. - -CONTRIBUTE A PATCH: - - The easiest way to create a patch with Git is to capture the output of - `git diff`: - - git diff > my_changes.patch - - The resulting patch file can then be attached to a JIRA issue. - -GITHUB PULL REQUESTS - - Github users may submit pull requests against our mirror: - - https://github.com/apache/lucy-clownfish - - An email notifying the Lucy developers list of your pull request will be - triggered automatically. - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..10c92d9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,89 @@ +================================ +Contributing to Apache Clownfish +================================ + +MAKE A PLAN: + + Clownfish is developed by the Apache Lucy community. + + http://lucy.apache.org/ + + If you propose to make non-trivial changes to Clownfish, especially changes + to the public API, send a note to the Lucy developer's list describing your + plans: + + http://lucy.apache.org/mailing_lists.html + +GET THE CODE: + + Clownfish's codebase is available via Git from git-wip-us.apache.org. Start + by creating a clone of the repository: + + git clone https://git-wip-us.apache.org/repos/asf/lucy-clownfish.git + + There is also a mirror on Github. + + https://github.com/apache/lucy-clownfish + + Follow the instructions in INSTALL to set up your local workspace. + +MAKE CHANGES: + + Edit the source code as you see fit, then build and run tests. + + Clownfish supports continuous integration services Travis and Appveyor + to run tests under multiple host languages, host language versions, and + platforms. If you fork the Github repository, you can make these services + automatically test the changes you made in your fork. + + Please bear the following in mind: + + * All code will eventually need to be portable to multiple operating + systems and compilers. (This is a complex requirement and it should not + block your contribution.) + * All public APIs must be documented. + * Code should be formatted according to the style guidelines at + <http://wiki.apache.org/lucy/LucyStyleGuide>. + * All unit tests must pass. + * New code needs to be accompanied by new unit tests. + * Simplicity, both in terms of API and implementation, is highly valued + within the Lucy development community; the simpler the contribution, the + more quickly it can be reviewed and integrated. + +OPEN AN ISSUE: + + Clownfish uses Lucy's issue-tracker/bug-tracker installation, which runs + Atlassian JIRA. We generally use the term "issue" rather than "bug" because + not every contribution fixes a "bug". + + https://issues.apache.org/jira/browse/CLOWNFISH + + 1. Create a JIRA account for yourself and sign in. + 2. Once you have signed in, the "create new issue" link will appear. Either + use it to open a new issue or navigate to an existing one as appropriate. + 3. To attach files to an issue, use the menu command + 'More Actions > Attach Files'. + + Attaching a file to an issue causes an email notification to be sent to the + lucy-issues list signalling that a patch has arrived. Please be patient but + persistent while engaging with the Lucy committers who review and apply such + patches. + +CONTRIBUTE A PATCH: + + The easiest way to create a patch with Git is to capture the output of + `git diff`: + + git diff > my_changes.patch + + The resulting patch file can then be attached to a JIRA issue. + +GITHUB PULL REQUESTS + + Github users may submit pull requests against our mirror: + + https://github.com/apache/lucy-clownfish + + An email notifying the Lucy developers list of your pull request will be + triggered automatically. + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/INSTALL ---------------------------------------------------------------------- diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 75c0a2c..0000000 --- a/INSTALL +++ /dev/null @@ -1,33 +0,0 @@ -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 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. - -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. - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/INSTALL.md ---------------------------------------------------------------------- diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..75c0a2c --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,33 @@ +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 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. + +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. + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/README ---------------------------------------------------------------------- diff --git a/README b/README deleted file mode 100644 index 8bc4d46..0000000 --- a/README +++ /dev/null @@ -1,14 +0,0 @@ -Apache Clownfish -================ - -OVERVIEW - -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. - -INSTALLATION - -To build and install Apache Clownfish, follow the instructions in the -accompanying "INSTALL" document. - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..8bc4d46 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +Apache Clownfish +================ + +OVERVIEW + +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. + +INSTALLATION + +To build and install Apache Clownfish, follow the instructions in the +accompanying "INSTALL" document. + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/compiler/c/INSTALL ---------------------------------------------------------------------- diff --git a/compiler/c/INSTALL b/compiler/c/INSTALL deleted file mode 100644 index 838563c..0000000 --- a/compiler/c/INSTALL +++ /dev/null @@ -1,44 +0,0 @@ -Build instructions for the Clownfish compiler -============================================= - -Building under UNIX and derivatives or Cygwin ---------------------------------------------- - - $ ./configure - $ make - $ make test - -Building under Windows ----------------------- - -You need MSVC or gcc as C compiler and nmake or mingw32-make as make utility. - -When using cmd.exe configure with: - - $ configure.bat - -When using the MSYS shell configure with: - - $ ./configure - -When building with nmake run: - - $ nmake - $ nmake test - -When building with mingw32-make run: - - $ mingw32-make - $ mingw32-make test - -Configuration -------------- - - ./configure [ options ] [ -- cflags ] - -Options include - - --enable-coverage - Enable code coverage. Create HTML pages with coverage data using - lcov by running "make coverage". - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/compiler/c/INSTALL.md ---------------------------------------------------------------------- diff --git a/compiler/c/INSTALL.md b/compiler/c/INSTALL.md new file mode 100644 index 0000000..838563c --- /dev/null +++ b/compiler/c/INSTALL.md @@ -0,0 +1,44 @@ +Build instructions for the Clownfish compiler +============================================= + +Building under UNIX and derivatives or Cygwin +--------------------------------------------- + + $ ./configure + $ make + $ make test + +Building under Windows +---------------------- + +You need MSVC or gcc as C compiler and nmake or mingw32-make as make utility. + +When using cmd.exe configure with: + + $ configure.bat + +When using the MSYS shell configure with: + + $ ./configure + +When building with nmake run: + + $ nmake + $ nmake test + +When building with mingw32-make run: + + $ mingw32-make + $ mingw32-make test + +Configuration +------------- + + ./configure [ options ] [ -- cflags ] + +Options include + + --enable-coverage + Enable code coverage. Create HTML pages with coverage data using + lcov by running "make coverage". + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/compiler/go/INSTALL ---------------------------------------------------------------------- diff --git a/compiler/go/INSTALL b/compiler/go/INSTALL deleted file mode 100644 index 3d44031..0000000 --- a/compiler/go/INSTALL +++ /dev/null @@ -1,20 +0,0 @@ -Apache Clownfish symbiotic object system -- CFC compiler Go bindings --------------------------------------------------------------------- - -These are temporary installation instructions for developers working on the -Apache Clownfish Go (golang) bindings. - -Make sure you have your GOPATH set, then clone the Clownfish git repository. - - mkdir -p $GOPATH/src/git-wip-us.apache.org/repos/asf - cd $GOPATH/src/git-wip-us.apache.org/repos/asf - git clone https://git-wip-us.apache.org/repos/asf/lucy-clownfish.git lucy-clownfish.git - cd lucy-clownfish.git/compiler/go - -From the `compiler/go` directory within the checkout, run `build.go`: - - go run build.go - go run build.go test - go run build.go install - go run build.go clean - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/compiler/go/INSTALL.md ---------------------------------------------------------------------- diff --git a/compiler/go/INSTALL.md b/compiler/go/INSTALL.md new file mode 100644 index 0000000..3d44031 --- /dev/null +++ b/compiler/go/INSTALL.md @@ -0,0 +1,20 @@ +Apache Clownfish symbiotic object system -- CFC compiler Go bindings +-------------------------------------------------------------------- + +These are temporary installation instructions for developers working on the +Apache Clownfish Go (golang) bindings. + +Make sure you have your GOPATH set, then clone the Clownfish git repository. + + mkdir -p $GOPATH/src/git-wip-us.apache.org/repos/asf + cd $GOPATH/src/git-wip-us.apache.org/repos/asf + git clone https://git-wip-us.apache.org/repos/asf/lucy-clownfish.git lucy-clownfish.git + cd lucy-clownfish.git/compiler/go + +From the `compiler/go` directory within the checkout, run `build.go`: + + go run build.go + go run build.go test + go run build.go install + go run build.go clean + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/compiler/perl/INSTALL ---------------------------------------------------------------------- diff --git a/compiler/perl/INSTALL b/compiler/perl/INSTALL deleted file mode 100644 index 77823b0..0000000 --- a/compiler/perl/INSTALL +++ /dev/null @@ -1,15 +0,0 @@ -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. - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/compiler/perl/INSTALL.md ---------------------------------------------------------------------- diff --git a/compiler/perl/INSTALL.md b/compiler/perl/INSTALL.md new file mode 100644 index 0000000..77823b0 --- /dev/null +++ b/compiler/perl/INSTALL.md @@ -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. + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/runtime/c/INSTALL ---------------------------------------------------------------------- diff --git a/runtime/c/INSTALL b/runtime/c/INSTALL deleted file mode 100644 index 5566b50..0000000 --- a/runtime/c/INSTALL +++ /dev/null @@ -1,46 +0,0 @@ -Build instructions for the Clownfish C library -============================================== - -Building under UNIX and derivatives or Cygwin ---------------------------------------------- - - $ ./configure - $ make - $ make test - -Building under Windows ----------------------- - -You need MSVC or gcc as C compiler and nmake or mingw32-make as make utility. - -When using cmd.exe configure with: - - $ configure.bat - -When using the MSYS shell configure with: - - $ ./configure - -When building with nmake run: - - $ nmake - $ nmake test - -When building with mingw32-make run: - - $ mingw32-make - $ mingw32-make test - -Configuration -------------- - - ./configure [ options ] [ -- cflags ] - -Options include - - --enable-coverage - Enable code coverage. Create HTML pages with coverage data using - lcov by running "make coverage". - --disable-threads - Disable thread support. - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/runtime/c/INSTALL.md ---------------------------------------------------------------------- diff --git a/runtime/c/INSTALL.md b/runtime/c/INSTALL.md new file mode 100644 index 0000000..5566b50 --- /dev/null +++ b/runtime/c/INSTALL.md @@ -0,0 +1,46 @@ +Build instructions for the Clownfish C library +============================================== + +Building under UNIX and derivatives or Cygwin +--------------------------------------------- + + $ ./configure + $ make + $ make test + +Building under Windows +---------------------- + +You need MSVC or gcc as C compiler and nmake or mingw32-make as make utility. + +When using cmd.exe configure with: + + $ configure.bat + +When using the MSYS shell configure with: + + $ ./configure + +When building with nmake run: + + $ nmake + $ nmake test + +When building with mingw32-make run: + + $ mingw32-make + $ mingw32-make test + +Configuration +------------- + + ./configure [ options ] [ -- cflags ] + +Options include + + --enable-coverage + Enable code coverage. Create HTML pages with coverage data using + lcov by running "make coverage". + --disable-threads + Disable thread support. + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/runtime/go/INSTALL ---------------------------------------------------------------------- diff --git a/runtime/go/INSTALL b/runtime/go/INSTALL deleted file mode 100644 index c5db488..0000000 --- a/runtime/go/INSTALL +++ /dev/null @@ -1,19 +0,0 @@ -Apache Clownfish symbiotic object system -- runtime Go bindings ---------------------------------------------------------------- - -These are temporary installation instructions for developers working on the -Apache Clownfish Go bindings. - -As a prerequisite, install the Go bindings for the Clownfish compiler (CFC). -This will entail cloning the Git repository which is shared by the runtime. - - # After installing CFC, switch to the runtime/go directory. - cd $GOPATH/src/git-wip-us.apache.org/repos/asf/lucy-clownfish.git/runtime/go - -From the `runtime/go` directory within the checkout, run `build.go`: - - go run build.go - go run build.go test - go run build.go install - go run build.go clean - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/runtime/go/INSTALL.md ---------------------------------------------------------------------- diff --git a/runtime/go/INSTALL.md b/runtime/go/INSTALL.md new file mode 100644 index 0000000..c5db488 --- /dev/null +++ b/runtime/go/INSTALL.md @@ -0,0 +1,19 @@ +Apache Clownfish symbiotic object system -- runtime Go bindings +--------------------------------------------------------------- + +These are temporary installation instructions for developers working on the +Apache Clownfish Go bindings. + +As a prerequisite, install the Go bindings for the Clownfish compiler (CFC). +This will entail cloning the Git repository which is shared by the runtime. + + # After installing CFC, switch to the runtime/go directory. + cd $GOPATH/src/git-wip-us.apache.org/repos/asf/lucy-clownfish.git/runtime/go + +From the `runtime/go` directory within the checkout, run `build.go`: + + go run build.go + go run build.go test + go run build.go install + go run build.go clean + http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/runtime/perl/INSTALL ---------------------------------------------------------------------- diff --git a/runtime/perl/INSTALL b/runtime/perl/INSTALL deleted file mode 100644 index 60185e0..0000000 --- a/runtime/perl/INSTALL +++ /dev/null @@ -1,15 +0,0 @@ -Installing the Clownfish runtime with Perl bindings -=================================================== - -To install the Clownfish runtime 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. - http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/c38a4db5/runtime/perl/INSTALL.md ---------------------------------------------------------------------- diff --git a/runtime/perl/INSTALL.md b/runtime/perl/INSTALL.md new file mode 100644 index 0000000..60185e0 --- /dev/null +++ b/runtime/perl/INSTALL.md @@ -0,0 +1,15 @@ +Installing the Clownfish runtime with Perl bindings +=================================================== + +To install the Clownfish runtime 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. +
