diff options
author | Ivan Enderlin <ivan.enderlin@hoa-project.net> | 2016-10-21 07:55:56 +0200 |
---|---|---|
committer | Ivan Enderlin <ivan.enderlin@hoa-project.net> | 2016-10-21 07:57:42 +0200 |
commit | f6f11fc7d51ea990a6f98c5c491ed5b2fa7ca769 (patch) | |
tree | 15fb6eb55c99f8f21339d1b5773867c12005d32d | |
parent | 68ce9beb71d9bb788e7ca6c04a5fe08632321c0d (diff) | |
download | Graph-f6f11fc7d51ea990a6f98c5c491ed5b2fa7ca769.zip Graph-f6f11fc7d51ea990a6f98c5c491ed5b2fa7ca769.tar.gz Graph-f6f11fc7d51ea990a6f98c5c491ed5b2fa7ca769.tar.bz2 |
Documentation: New `README.md` file.
-rw-r--r-- | README.md | 101 |
1 files changed, 80 insertions, 21 deletions
@@ -1,30 +1,63 @@ - - -Hoa is a **modular**, **extensible** and **structured** set of PHP libraries. -Moreover, Hoa aims at being a bridge between industrial and research worlds. - -# Hoa\Graph  +<p align="center"> + <img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" /> +</p> + +--- + +<p align="center"> + <a href="https://travis-ci.org/hoaproject/graph"><img src="https://img.shields.io/travis/hoaproject/graph/master.svg" alt="Build status" /></a> + <a href="https://coveralls.io/github/hoaproject/graph?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/graph/master.svg" alt="Code coverage" /></a> + <a href="https://packagist.org/packages/hoa/graph"><img src="https://img.shields.io/packagist/dt/hoa/graph.svg" alt="Packagist" /></a> + <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/graph.svg" alt="License" /></a> +</p> +<p align="center"> + Hoa is a <strong>modular</strong>, <strong>extensible</strong> and + <strong>structured</strong> set of PHP libraries.<br /> + Moreover, Hoa aims at being a bridge between industrial and research worlds. +</p> + +# Hoa\Graph + +[](https://webchat.freenode.net/?channels=#hoaproject) +[](https://gitter.im/hoaproject/central) +[](https://central.hoa-project.net/Documentation/Library/Graph) +[](https://waffle.io/hoaproject/graph) This library allows to create and manipulate directed graphs, a common data structure. A directed graph is basically a set of vertices (aka nodes) and directed edges between vertices. +[Learn more](https://central.hoa-project.net/Documentation/Library/Graph). + ## Installation -With [Composer](http://getcomposer.org/), to include this library into your -dependencies, you need to require -[`hoa/graph`](https://packagist.org/packages/hoa/graph): +With [Composer](https://getcomposer.org/), to include this library into +your dependencies, you need to +require [`hoa/graph`](https://packagist.org/packages/hoa/graph): -```json -{ - "require": { - "hoa/graph": "~1.0" - } -} +```sh +$ composer require hoa/graph '~1.0' ``` -Please, read the website to [get more informations about how to -install](http://hoa-project.net/Source.html). +For more installation procedures, please read [the Source +page](https://hoa-project.net/Source.html). + +## Testing + +Before running the test suites, the development dependencies must be installed: + +```sh +$ composer install +``` + +Then, to run all the test suites: + +```sh +$ vendor/bin/hoa test:run +``` + +For more information, please read the [contributor +guide](https://hoa-project.net/Literature/Contributor/Guide.html). ## Quick usage @@ -83,6 +116,7 @@ $ dot -Tsvg -oresult.svg <( echo 'digraph { … }'; ) ``` And the result should look like the following image: +  We can see that `n1` is the parent of `n2` and `n3`. `n2` is the parent of `n3`. @@ -95,10 +129,35 @@ information on it. The `SimpleNode` class has been used. It extends the ## Documentation -Different documentations can be found on the website: -[http://hoa-project.net/](http://hoa-project.net/). +The +[hack book of `Hoa\Graph`](https://central.hoa-project.net/Documentation/Library/Graph) +contains detailed information about how to use this library and how it works. + +To generate the documentation locally, execute the following commands: + +```sh +$ composer require --dev hoa/devtools +$ vendor/bin/hoa devtools:documentation --open +``` + +More documentation can be found on the project's website: +[hoa-project.net](https://hoa-project.net/). + +## Getting help + +There are mainly two ways to get help: + + * On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject) + IRC channel, + * On the forum at [users.hoa-project.net](https://users.hoa-project.net). + +## Contribution + +Do you want to contribute? Thanks! A detailed [contributor +guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains +everything you need to know. ## License -Hoa is under the New BSD License (BSD-3-Clause). Please, see -[`LICENSE`](http://hoa-project.net/LICENSE). +Hoa is under the New BSD License (BSD-3-Clause). Please, see +[`LICENSE`](https://hoa-project.net/LICENSE) for details. |