octoleo/plantuml
1
0
Fork 0
mirror of https://github.com/octoleo/plantuml.git synced 2024-11-05 21:17:52 +00:00
Code Issues Releases Wiki Activity

Merge pull request #10 from mikeando/mikeando-overview-md

Browse Source 
Created README.md in src directory
This commit is contained in:
arnaudroques 2019-10-04 17:53:25 +02:00 committed by GitHub
commit ff66cc3e8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
src/README.md Normal file
View File

@ -0,0 +1,54 @@
# PlantUML : a free UML diagram generator
---
(C) Copyright 2009-2013, Arnaud Roques
Project Info: [http://plantuml.sourceforge.net](http://plantuml.sourceforge.net)
This file is part of PlantUML.
PlantUML is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PlantUML distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.
You should have received a copy of the GNU General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
USA.
Java is a trademark or registered trademark of Sun Microsystems, Inc.
in the United States and other countries.
Original Author: Arnaud Roques
---
PlantUML is an open-source component used to draw UML diagrams from their textual description.
### Overview
This documentation will _not_ describe the PlantUML language description.
Please refer to [PlantUML site](http://plantuml.sourceforge.net) for that.
Here, some information about how PlantUML is implemented will be provided to help the
integration of PlantUML with other programs.
Unfortunatly, here, we have to raise a **warning**:
While PlantUML language description remains stable over version and follow ascending
compatibility, the *implementation* of PlantUML changes very often over time.
So if you use classes described in this documentation, it's very likely that you will have
an issue someday, because thoses class may change without any notice. They could even be deleted.
It used to happen more often than you think over years, because we try to constantly improve the
general design of PlantUML, and this imply a continuous refactoring.
The only exception is the `net.sourceforge.plantuml` package, that we will keep
as stable as possible over time.