Source code file content

mercurial-code-repository / BUILDME.txt

Wembed, embed your web apps
http://kenai.com/projects/wembed/

Version 1.0

Build instructions
------------------------------------------

BEFORE WE START
---------------
The building script expects you to have 2 directories defined:
.- One directory, deploy, where the you want the compiled artifacts and libraries to be
placed. Those files will be in a "Wembed" directory inside the deploy directory.

.- One directory, ivy.home, where Ivy, the dependency manager, will be stored along
all the third party libraries used by the project

For example, we have our directories like these:
deploy=D:/Apps/deploy
ivy.home=D:/Java/Ivy

When you are done, you will be able to run the Wembed container by executing the
resulting jar file that will be stored at ${deploy}/bin/wembed-server.jar. You
will also be able to configure the behaviour of the server by editing the property
files located at the ${deploy}/bin/ directory.

SETTING UP THE ENVIRONMENT
--------------------------

.- Install Ant 1.7 or higher as per Ant documentation instructions (Basically, set
the ANT_HOME variable and put $ANT_HOME/bin in yout PATH)

.- Make a copy of the file app.properties.sample and name it app.properties.

.- Edit this file and substitute all the '***TO_BE_DEFINED***' values
with the real values to the paths of the libraries you defined and
to the directories "deploy" and "ivy.home" (Note: Don't forget to
change '\' for '/' in paths if you are using Windows)

.- Execute 'ant'. If you don't have Ivy installed, it might take a while
to download all the required dependencies, be patient and if you get an error
due to some timeout, try again after some minutes; the public repositories
from where the dependencies are downloaded might be having connectivity problems.
With all the dependencies downloaded, build time is much faster.

.- To clean completely all the libraries downloaded, including Ivy and its cache,
use "ant clean clean-ivy clean-ivy-cache" But be careful to use this command if
you use Ivy for other projects, as it will wipe out the cache. If you simply
want to remove this project, use "ant clean" and that's all.

.- NOTE: If you want to place your properties file in a
different place or name it differently, you can do so by passing
the new name or location to the build script using the "properties.file"
flag. Like that:

$HOME_DIR\Wembed>ant -Dproperties.file=../custom.properties