Source code file content

mercurial-code-repository / README.txt

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

Version 1.0

Release notes
------------------------------------------
See doc/Release_Notes.html

INTRODUCTION
------------
Wembed is a tiny utility that encapsulates servlet containers
that can be embedded so they can be used more easily to test
web applications.

The idea is to allow developers to test web applications with different
containers just by doing some small configuration changes, and 
also allowing them to be able to use those embedded containers in
automatic tests with Ant.

RUNNING WEMBED
--------------
Running the Wembed server is very simple, you just have to execute the file 
Wembed-server.jar that is located at the "bin" folder. For example, by 
issuing the following command:
	> java -jar Wembed-server.jar
This will start the server at the configured port (default 8080) and display a
small GUI to show the status of the server. Check the documentation at the
project's wiki, http://kenai.com/projects/wembed/pages/Home, to see the different
configuration options and how to use Wembed with your projects.
  
LICENSING
---------
This software is licensed under the LGPL license and also makes use of
other open source libraries. Please to the files ./doc/Wembed-License.txt
and ./doc/Third-party-licenses.txt for specific details and more license
and copyright information.

DOCUMENTATION
-------------------
Documentation for the Wembed project is maintained online at the
project's wiki: http://kenai.com/projects/wembed/pages/Home

BUILDING THE FRAMEWORK FROM THE SOURCE
--------------------------------------
If you want to build the framework from the source, follow the instructions
on the wiki on how to download the source and then refer to the file
BUILDME.txt for the simple steps to build the project.

Dependencies are downloaded automatically so to start you will just need:

JDK1.6:           http://java.sun.com/javase/6/docs/
Ant(1.7+):        http://ant.apache.org/