diff --git a/README.md b/README.md new file mode 100644 index 0000000..2388b95 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# UMLGraph - Declarative Drawing of UML Diagrams + +*UMLGraph* allows the declarative specification and drawing of +UML diagrams. +You can browse the system's documentation +through [this link](http://www.spinellis.gr/umlgraph/doc/index.html), +or print it through [this link](http://www.spinellis.gr/umlgraph/doc/indexw.html). + +To install the elements required to run *UMLGraph*, simply copy +the contents of the *lib* directory to a location consistent with +your installation's conventions (for example to `/usr/local/lib`). + +To compile the Java doclet from the source code run *ant* on the +*build.xml* file. + +If you change the source code, you can run regression tests by +executing *ant test*. + +Visit the project's [home page](http://www.spinellis.gr/umlgraph) for more information. diff --git a/README.mediawiki b/README.mediawiki deleted file mode 100644 index e181953..0000000 --- a/README.mediawiki +++ /dev/null @@ -1,23 +0,0 @@ -==UMLGraph - Declarative Drawing of UML Diagrams== - -''UMLGraph'' allows the declarative specification and drawing of -UML diagrams. -You can browse the system's documentation -through [http://www.spinellis.gr/umlgraph/doc/index.html this link], -or print it through [http://www.spinellis.gr/umlgraph/doc/indexw.html this link]. - -To install the elements required to run ''UMLGraph'', simply copy -the contents of the ''lib'' directory to a location consistent with -your installation's conventions (for example to /usr/local/lib). - -To compile the Java doclet from the source code run ''ant'' on the -''build.xml'' file. - -If you change the source code, you can run regression tests by -executing ''ant test''. - -Visit the project's [http://www.spinellis.gr/umlgraph home page] for more information. - ----- - -Diomidis Spinellis - November 2005, August 2008, April 2012, September 2016