Content of the README initialized

This commit is contained in:
Maxime Sinclair 2011-02-16 09:06:42 +01:00
parent df1d78f052
commit 8f310349c8
1 changed files with 21 additions and 0 deletions

21
README
View File

@ -0,0 +1,21 @@
* PlantUMLServlet description
*****************************
PlantUMLServlet is a PlantUML extension to generate images on-the-fly.
To know more about PlantUML, please visit http://plantuml.sourceforge.net/
* How to build the project
**************************
To build the project you need to install the following components :
- java jdk 1.6.0 or above
- apache tomcat 6.0 or above
- apache ant 1.7 or above
If the tomcat home directory is not /tomcat, you have to create at
the root of the project a text file named user.property and
containing the following line:
tomcat-home=<your tomcat home dir>
For example, on a Windows environment, your user.property file can be:
tomcat-home=C:/tools/Tomcat6.0
To build the war, just run "ant" at the root directory of the project.