README updated to mavenized project and translated to markdown

2011-11-02 19:23:39 -03:00
parent 89c4d91b41
commit b66a774bc7
2 changed files with 16 additions and 21 deletions
--- a/README.md
+++ 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.