Skip to content

Getting started

Requirements

  • PHP 8.2 or greater
  • graphp/graph package from master branch (considered as future stable v1.0.0)
  • graphp/graphviz package from master branch (considered as future stable v1.0.0)

Installation

With Composer

The recommended way to install this library is through composer. If you don't know yet what is composer, have a look on introduction.

composer require bartlett/graph-uml ^1.7

With Git

The Graph-UML can be directly used from GitHub by cloning the repository into a directory of your choice.

git clone -b 1.7 https://github.com/llaville/graph-uml.git

Additionally, you'll have to install GraphViz (dot executable). Users of Debian/Ubuntu-based distributions may simply invoke:

sudo apt update
sudo apt-get install graphviz -y

while remaining users should install from GraphViz Download page.