Skip to content

Commit

Permalink
formatted to match markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Alain Petignat committed Feb 11, 2011
1 parent 517e9db commit 8d9fcaf
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
*********
Jackalope
*********

# Jackalope

Implementation of a PHP client for the Jackrabbit server, an implementation of
the Java Content Repository JCR.

Implements the PHPCR interface (see the phpcr submodule in the lib directory for
more about PHPCR).

http://liip.to/jackalope
[http://liip.to/jackalope](http://liip.to/jackalope)

Visit us at #jackalope on irc.freenode.net

Expand All @@ -16,53 +16,49 @@ david at liip.ch
chregu at liip.ch


**************
Preconditions
*************

* libxml version >= 2.7.0 (due to a bug in libxml http://bugs.php.net/bug.php?id=36501)
# Preconditions


*****
Setup
*****
* libxml version >= 2.7.0 (due to a bug in libxml [http://bugs.php.net/bug.php?id=36501](http://bugs.php.net/bug.php?id=36501))


# Setup

This is only the frontend. In order to actually do something, you need the
Jackrabbit server. Please download Jackrabbit here: http://jackrabbit.apache.org
You need the jackrabbit-standalone-2.x.jar

Once you have the jar, start it with
$ java -jar jackrabbit*.jar
$ java -jar jackrabbit*.jar

When you start it the first time, this will create a folder called "jackrabbit" with some subfolders. In order to get the tests up and running, you need to create a workspace called tests.

cp -rp jackrabbit/workspaces/default/ jackrabbit/workspaces/tests/
cp -rp jackrabbit/workspaces/default/ jackrabbit/workspaces/tests/

You need to adjust the attribute "name" in jackrabbit/workspaces/tests/workspace.xml from "default" to "tests". After changing the workspace.xml, you'll have to restart jackrabbit.

Clone the jackalope project

git clone git://github.com/jackalope/jackalope.git
git clone git://github.com/jackalope/jackalope.git

Update submodules

git submodule init
git submodule update
git submodule init
git submodule update

Now you are ready to use the library. Have a look at api-tests/bootstrap.php
too see how to instantiate a repository.


*****
Tests
*****
# Tests

There is our continuos integration server with coverage reports at:
http://bamboo.liip.ch/browse/JACK
[http://bamboo.liip.ch/browse/JACK](http://bamboo.liip.ch/browse/JACK)

Run phpunit from the api-tests directory. You should have a lot of failed tests,
but no exception. If you have something like this, it works (yeah, FAILURES are ok):
FAILURES!
Tests: 224, Assertions: 99, Failures: 8, Errors: 183, Incomplete: 6, Skipped: 10.
FAILURES!
Tests: 224, Assertions: 99, Failures: 8, Errors: 183, Incomplete: 6, Skipped: 10.


There are two kind of tests. The folder *api-tests* contains the
Expand Down

0 comments on commit 8d9fcaf

Please sign in to comment.