Skip to content

Commit

Permalink
Merge pull request plantuml#16 from ftomassetti/readme
Browse files Browse the repository at this point in the history
Add a screenshot in the README file
  • Loading branch information
maximesinclair committed Mar 29, 2015
2 parents e08b3dc + f29e061 commit a785860
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 12 deletions.
43 changes: 31 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,42 @@ PlantUML Server
[![Build Status](https://travis-ci.org/plantuml/plantuml-server.png?branch=master)](https://travis-ci.org/plantuml/plantuml-server)

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/.

How to build the project
========================

To build the project you need to install the following components:
Requirements
============

* java jdk 1.6.0 or above
* jre/jdk 1.6.0 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
plantuml.war in the target/ directory.
How to run the server
=====================

Just run:

```
mvn jetty:run
```

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:

How to testrun the project
==========================
```
mvn package
```

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
to start up). If you want to run it on some custom port run "mvn jetty:run -Djetty.port=9999".
at the root directory of the project to produce plantuml.war in the target/ directory.
Binary file added screenshots/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a785860

Please sign in to comment.