From b66a774bc7ddb8e12d7bca74b0f7835c5f2fcf24 Mon Sep 17 00:00:00 2001 From: Pablo Lalloni Date: Wed, 2 Nov 2011 19:23:39 -0300 Subject: [PATCH] README updated to mavenized project and translated to markdown --- README | 21 --------------------- README.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 21 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 9db8788..0000000 --- a/README +++ /dev/null @@ -1,21 +0,0 @@ -* 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= - -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebdb593 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +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 maven 3.0.2 or above + +To build the war, just run "maven package" at the root directory of the project.