File	Date	Author	Commit
src	2019-07-16	rrugiero	[10282e] Added network diagram examples
.gitignore	2015-06-20	Raul Rugiero	[9d7b09] Refactoring project
LICENSE.txt	2015-06-15	unknown	[2fda90] Initial commit
README.txt	2017-03-04	rrugiero	[1e0341] Added remaining UML diagram examples.
ReleaseNotes.txt	2019-07-16	rrugiero	[10282e] Added network diagram examples
distribution.bat	2017-03-02	rrugiero	[e62b05] Updated deploy facilities
nb-configuration.xml	2017-02-25	Rugiero	[2722c5] First import of changes in branch.
nbactions.xml	2017-02-25	Rugiero	[2722c5] First import of changes in branch.
pom.xml	2019-07-15	rrugiero	[49bce6] Version 2.2 - Added export to SVG, font increas...

Read Me

PUed is a PlantUML (http://plantuml.sourceforge.net/) scripts editor able to
generate UML diagram images (PNG) by means of the PlantUML capabilities.
 
PUed is a Java desktop application based on the JavaFX technology.
The user interface is so simple and friendly that there is no need of help.

External libraries
------------------

In general all the libraries provided in lib distribution folder may be
substituted with more recent versions if available.


PlantUML
--------

It is recommended to update the PlantUML library (plantuml.jar) provided in 
lib distribution folder when a more recent versions if available. 
It is possible to get the currently used PlantUML version by loading in the
PUed editor the following script (for example by pressing "Help" and then 
"Plugin version" from the PUed toolbar) and generating the diagram.

@startuml
version
@enduml


Graphviz
--------

The Graphviz platform (http://www.graphviz.org/) is required in order to 
exploit all PlantUML features. If Graphviz is installed then the GRAPHVIZ_DOT 
environment variable shall be configured to reference the dot executable. 
For example, in Microsoft Windows, assuming "C:\Graphviz" as the root path,
then GRAPHVIZ_DOT shall point to "C:\Graphviz\bin\dot.exe".


Installing and running
----------------------

To install PUed simply unzip the distribution file in a void folder. 

A Java Virtual Machine (1.8+) and a graphical environment is required to run 
the PUed application.

From an enabled desktop:
	- double click on PUed-x.y.z.jar
From a console:
	- java  -jar PUed-x.y.z.jar
	- javaw -jar PUed-x.y.z.jar

After the first run in the user home directory the ".pued" folder is created.
In this folder the PUed application stores user's configuration and data such
as the recent used file list.