mirror of
https://github.com/octoleo/plantuml-server.git
synced 2024-12-22 08:48:54 +00:00
README updated to mavenized project and translated to markdown
This commit is contained in:
parent
89c4d91b41
commit
b66a774bc7
21
README
21
README
@ -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=<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.
|
16
README.md
Normal file
16
README.md
Normal file
@ -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.
|
Loading…
Reference in New Issue
Block a user