BITPlan UML2PHP readme

BITPlan Readme Version 2.0 - 2008-02-19

Thank you for using UML2PHP - we appreciate your time and effort and therefore try to keep this short.

What is it?

UML2PHP is a tool that generates PHP5 web-applications from UML models. It is very versatile and can be used to create simple source code or full fledged applications. The enterprise version even allows to configure your own software architecture to use. The UML2PHP base framework is now an Open Source project on Sourceforge.net. You are heartily invited to participate so that the planned community edition of UML2PHP gets boosted by you being an active member of the UML2PHP community.

What do you need to know?
You might want to be familiar with UML, PHP5 and programming web application using html in general to use UML2PHP. Software-Architecture knowledge is helpful if you intend to use advanced features.

If these prerequisites are missing for you don't be desperate - BITPlan can help - have a look at our Trainings-Offer,

System-Requirements

JDK 1.4.2 or higherenvironment - JDK 1.5 has been tested successfully
PC with Windows NT technology e.g. Windows NT, 2000 or XP to use the installation executable - please call to get installation files for other target operating systems - UML2PHP for example successfully runs on Linux and MacOS!
Microsoft Internet Explorer or Netscape Communicator 4.0 or higher with JavaScript enabled
Apache Web server 1 or 2.0.48 or higher
MySQL 5.0.24 or higher has been tested successfully - MySQL 4.0.17 or higher can still be used but will be deprecated soon - some test cases already fail with mySQL 4.x
PHP 5.0.0RC2 or higher - UML2PHP does not work with PHP4 but PHP5.1 is fine!
Adobe Acrobat reader to read PDF documentation.
An UML tool of your choice that supports XMI export and is supported by UML2PHP
see http://www.uml2php.com for a list of supported UML tools.
We recommend Poseidon by Gentleware since it has native XMI support.

For a simplified installation there is also XAMPP available. This is a desktop verion of Apache, MySQL and PHP5 plus some tools that can be used if you intend to setup a development environment only.

Installation

On Windows start UML2PHP.exe and follow the instructions of the installation wizard

Finally the UML2PHP configuration wizard will be started.

For all further steps choose Program Files/BITPlan/UML2PHP/DOC/User Manual from the Start menu.

Please also refer to the release notes and reference manual.

You can find links to these files in the Windows menu after you have installed UML2PHP.

User Forum
There is a user forum for UML2PHP available for exchanging all kinds of information around the product.

Troubleshooting issues

You are most welcome to tell us Bugreports, Hints, any additional features you'd like to see or just comments of any kind about UML2PHP.
Our feedback form will help you getting in touch with us easily.

You may also contact us via phone/fax or letter at:
    BITPlan GmbH
    Pater-Delp-Str. 1
    47877 Willich-Schiefbahn
    Fon: +49 1805 2487526
    Fax: +49 2154 811-481
    e-Mail: info@bitplan.com