Merge pull request #16 from ftomassetti/readme

Add a screenshot in the README file
This commit is contained in:
Maxime Sinclair
2015-03-29 23:52:13 +02:00
2 changed files with 31 additions and 12 deletions

View File

@@ -4,22 +4,41 @@ PlantUML Server
PlantUML Server is a web application to generate UML diagrams on-the-fly. PlantUML Server is a web application to generate UML diagrams on-the-fly.
![](https://raw.githubusercontent.com/ftomassetti/plantuml-server/readme/screenshots/screenshot.png)
To know more about PlantUML, please visit http://plantuml.sourceforge.net/. To know more about PlantUML, please visit http://plantuml.sourceforge.net/.
How to build the project Requirements
======================== ============
To build the project you need to install the following components: * jre/jdk 1.6.0 or above
* java jdk 1.6.0 or above
* apache maven 3.0.2 or above * apache maven 3.0.2 or above
To build the war, just run "mvn package" at the root directory of the project to produce How to run the server
plantuml.war in the target/ directory. =====================
How to testrun the project Just run:
==========================
To run the application deployed on an embedded jetty server run "mvn jetty:run" ```
and go to http://localhost:8080/plantuml with your favorite web browser (after it finishes mvn jetty:run
to start up). If you want to run it on some custom port run "mvn jetty:run -Djetty.port=9999". ```
The server is now listing to [http://localhost:8080/plantuml](http://localhost:8080/plantuml).
In this way the server is run on an embedded jetty server.
You can specify the port at which it runs:
```
mvn jetty:run -Djetty.port=9999"
```
How to generate the war
=======================
To build the war, just run:
```
mvn package
```
at the root directory of the project to produce plantuml.war in the target/ directory.

BIN
screenshots/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB