build/resources/src/README

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Welcome to Apache ACE
=====================

Apache ACE is a software distribution framework that allows you to centrally
manage and distribute software components, configuration data and other
artifacts to target systems. It is built using OSGi and can be deployed in
different topologies. The target systems are usually also OSGi based, but
don't have to be.


Building Apache ACE
===================

Initial Setup
--------------

There are two ways of building and developing ACE: on the command line and
within Eclipse. Below are the requirements in case you want to be able to do
both:

1)  Install Java SE 7 (or later), which can be downloaded from
    http://www.oracle.com/technetwork/java/javase/downloads/index.html

2)  Make sure that your JAVA_HOME environment variable is set to the newly
    installed JDK location, and that your PATH includes
    %JAVA_HOME%\bin (windows) or $JAVA_HOME/bin (unix).
    
3)  Install the latest version of Eclipse with the following plugins:
    * Subclipse;
    * BndTools;
    * TestNG.

Building
--------

From the command line:

1)  Go into the source root directory and invoke the Gradle wrapper:
    $ ./gradlew build

2)  To generate the various binaries, you can optionally invoke:
    $ ./gradlew runbundles
    The binaries can be found in the `run-*/generated/executables/`.

Within Eclipse:

From the main menu in Eclipse, choose: "File -> Import..." and then
select "General -> Existing projects into workspace..." and select
your workspace folder. A list of projects should show up now. Import
them all, wait until Eclipse has built the project and you're ready
to start.

The latest instructions can always be found on our website:

http://ace.apache.org/dev-doc/getting-started.html


Getting Started
===============

To start using Apache ACE, please go to our website and read the
getting started guide for users:

http://ace.apache.org/user-doc/getting-started.html

Many thanks for using Apache ACE.

The ACE Team