Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename master branch to 1.x and update installation instructions #64

Merged
merged 1 commit into from
Oct 27, 2022
+19 −11
Merged

Rename master branch to 1.x and update installation instructions #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,22 @@

GraphViz graph drawing for the mathematical graph/network library GraPHP.

> **Development version:** This branch contains the code for the upcoming 1.0 release.
> For the code of the current stable 0.2 release, check out the
> [`0.2.x` branch](https://github.com/graphp/graphviz/tree/0.2.x).
>
> The upcoming 1.0 release will be the way forward for this package.
> However, we will still actively support 0.2.x for those not yet
> on the latest version.
> See also [installation instructions](#install) for more details.

The library supports visualizing graph images, including them into webpages,
opening up images from within CLI applications and exporting them
as PNG, JPEG or SVG file formats (among many others).
Because [graph drawing](http://en.wikipedia.org/wiki/Graph_drawing) is a complex area on its own,
the actual layouting of the graph is left up to the excelent [GraphViz](http://www.graphviz.org/)
"Graph Visualization Software" and we merely provide some convenient APIs to interface with GraphViz.

> Note: This project is in beta stage! Feel free to report any issues you encounter.

**Table of contents**

* [Quickstart examples](#quickstart-examples)
Expand Down Expand Up @@ -411,13 +418,14 @@ See also the [examples](examples/).

## Install

The recommended way to install this library is [through Composer](https://getcomposer.org).
The recommended way to install this library is [through Composer](https://getcomposer.org/).
[New to Composer?](https://getcomposer.org/doc/00-intro.md)

This will install the latest supported version:
Once released, this project will follow [SemVer](https://semver.org/).
At the moment, this will install the latest development version:

```bash
$ composer require graphp/graphviz:^0.2.2
composer require graphp/graphviz:^1@dev
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
Expand All @@ -434,24 +442,24 @@ installation instructions for most common platforms, users of Debian/Ubuntu-base
distributions may simply invoke:

```bash
$ sudo apt install graphviz
sudo apt install graphviz
```

## Tests

To run the test suite, you first need to clone this repo and then install all
dependencies [through Composer](https://getcomposer.org):
dependencies [through Composer](https://getcomposer.org/):

```bash
$ composer install
composer install
```

To run the test suite, go to the project root and run:

```bash
$ php vendor/bin/phpunit
vendor/bin/phpunit
```

## License

Released under the terms of the permissive [MIT license](http://opensource.org/licenses/MIT).
This project is released under the permissive [MIT license](LICENSE).
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"require": {
"php": ">=5.3.0",
"graphp/graph": "dev-master#214de45 as 1.0.0"
"graphp/graph": "^1@dev"
},
"require-dev": {
"phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35"
Expand Down