Skip to content

Commit

Permalink
update to docs and removed some redundant information
Browse files Browse the repository at this point in the history
  • Loading branch information
pax committed Feb 20, 2009
1 parent 0be8724 commit 6b35ed9
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 12 deletions.
18 changes: 8 additions & 10 deletions INSTALL
@@ -1,8 +1,8 @@

The axiom project is built using maven2, and requires Java >= 1.5 to compile. In
order to run the jtestr tests on unix based operating systems, it is necessary to
use Java 1.6. I've made this the default source and JDK level in the pom
build section, as we never build anything without also testing it.
order to run the jtestr tests on os-x, it is necessary to use Java 1.6.
I've therefore made this the default source and JDK level in the pom
build section.

Install:

Expand All @@ -11,9 +11,7 @@ You should be able to accomplish this by running the command:
$ mvn clean install

Note that you may need to edit your personal ~/.m2/settings.xml file in order to
access some of the repositories in which dependencies are being installed. You
may also need to configure your mirror/proxy servers (nexus, for example) if
trying to build from inside the corporate firewall for the first time.
access some of the repositories in which dependencies are being installed.

Testing:

Expand All @@ -30,12 +28,12 @@ Notes:
Installing on OSX

There are some *special* problems when installing on OSX, not the least of which
is that Java 1.6 is still not fully supported (at the time of writing) therefore
you should take some additional steps to ensure that both maven and its plugins
is that Java 1.6 is still not the default JDK on Leopard, therefore you should
probably take some additional steps to ensure that both maven and its plugins
use the correct JDK (1.6).

Export the following environment variables into the bash session in which you're
launching maven:
One way to do this is by exporting the following environment variables into the
bash session in which you're launching maven:

export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Home
export JAVA_VERSION=1.6
Expand Down
3 changes: 2 additions & 1 deletion LICENSE
Expand Up @@ -22,4 +22,5 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

44 changes: 43 additions & 1 deletion README
@@ -1,5 +1,47 @@

Introduction
-------------

An axiom is a proposition not proved or demonstrated, but taken for granted,
to serve as a starting point for deducing and inferring other truths.

For details on build/install please read the relevant INSTALL document.
This particular axiom, is a framework for testing integration scenarios and
validating expectations about routing/rules and business logic executed in
a variety of systems integration landscapes.

The projects aims are:

- Make testing integration scenarios simple(r)
- Simple to understand
- Simple to configure, deploy and run axiom itself
- Simple to hook up to your existing infrastructure
- Facilitate instrumenting/debugging complex integration architectures (simply)
- Provide a set of (simple) mechanisms for verifying rules/constraints
- Provide immediate feedback in useful formats (surefire reports, rss feeds, email, etc)

Axiom is distributed under a BSD-style license (please see the LICENSE document for details).

Overview
---------

Axiom is a java application with embedded jruby. It uses the apache camel
routing/mediation engine to interact with your integration stack (messaging
systems, web servers, service brokers, ESBs, etc). Camel not only integrates
well with a variety of different transports/protocols, it also provides a rich
routing DSL (in java, scala or spring-xml dialects) which makes for simple configuration.

The camel libraries also provide a lot of the Enterprise Integration Patterns
as components of the framework, making it simpler and easier to reason about your
design using well trodden techniques.

Status
-------

Axiom is in the Alpha::Prototyping stage and is not yet fit for purpose
(and certainly isn't ready for use in a real environment, test or otherwise).

Getting Started
----------------

For details on how to build and/or install please read the relevant INSTALL document.

0 comments on commit 6b35ed9

Please sign in to comment.