GitHub documentation

This commit is contained in:
Diomidis Spinellis 2012-04-25 12:58:19 +03:00
parent e87bfa6d8a
commit 4af68f0d3a
3 changed files with 32 additions and 3 deletions

21
README.mediawiki Normal file
View File

@ -0,0 +1,21 @@
==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://umlgraph.org/doc/index.html this link]],
or print it through [[http://umlgraph.org/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.umlgraph.org home page] for more information.
Diomidis Spinellis - November 2005, August 2008, April 2012

View File

@ -16,7 +16,6 @@ If you change the source code, you can run regression tests by
executing "ant test".
Project home page: http://www.umlgraph.org
GitHub page: git@github.com:dspinellis/UMLGraph.git
Diomidis Spinellis - November 2005, August 2008
$Id$
Diomidis Spinellis - November 2005, August 2008, April 2012

View File

@ -23,6 +23,15 @@ please use this only for pulling UmlGraph into other projects).
</li>
</ul>
<h2>Source Code Repository</h2>
The
<a href="https://github.com/dspinellis/UMLGraph">UMLGraph source code repository</a>
is available on GitHub.
You can clone it by running the following command.
<pre>
git clone git@github.com:dspinellis/UMLGraph.git
</pre>
<h2>Older Versions</h2>
These are links to old versions of UMLGraph, that may be useful to
people running older versions of the Java runtime environment.