diff options
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-21 17:01:48 +0200
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2016-10-21 17:01:48 +0200
commit6f1d2071d1275dc237307633444d96c582edb6bd (patch)
parent70b0b41e9b733df45026efaf1416ac56802742bf (diff)
Documentation: New `README.md` file.
1 files changed, 81 insertions, 23 deletions
diff --git a/README.md b/README.md
index e67c8c8..644afd2 100644
--- a/README.md
+++ b/README.md
@@ -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\Regex ![state](http://central.hoa-project.net/State/Regex)
+<p align="center">
+ <img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" />
+<p align="center">
+ <a href="https://travis-ci.org/hoaproject/regex"><img src="https://img.shields.io/travis/hoaproject/regex/master.svg" alt="Build status" /></a>
+ <a href="https://coveralls.io/github/hoaproject/regex?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/regex/master.svg" alt="Code coverage" /></a>
+ <a href="https://packagist.org/packages/hoa/regex"><img src="https://img.shields.io/packagist/dt/hoa/regex.svg" alt="Packagist" /></a>
+ <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/regex.svg" alt="License" /></a>
+<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.
+# Hoa\Regex
+[![Help on IRC](https://img.shields.io/badge/help-%23hoaproject-ff0066.svg)](https://webchat.freenode.net/?channels=#hoaproject)
+[![Help on Gitter](https://img.shields.io/badge/help-gitter-ff0066.svg)](https://gitter.im/hoaproject/central)
This library provides tools to analyze regular expressions and generate strings
based on regular expressions ([Perl Compatible Regular
+[Learn more](https://central.hoa-project.net/Documentation/Library/Regex).
## Installation
-With [Composer](http://getcomposer.org/), to include this library into your
-dependencies, you need to require
+With [Composer](https://getcomposer.org/), to include this library into
+your dependencies, you need to
+require [`hoa/regex`](https://packagist.org/packages/hoa/regex):
+$ composer require hoa/regex '~1.0'
+For more installation procedures, please read [the Source
+## Testing
+Before running the test suites, the development dependencies must be installed:
+$ composer install
+Then, to run all the test suites:
- "require": {
- "hoa/regex": "~1.0"
- }
+$ vendor/bin/hoa test:run
-Please, read the website to [get more informations about how to
+For more information, please read the [contributor
## Quick usage
@@ -35,7 +68,7 @@ on a regular expression by visiting its AST with an isotropic random approach.
### Analyze regular expressions
We need the [`Hoa\Compiler`
-library](http://central.hoa-project.net/Resource/Library/Compiler) to lex, parse
+library](https://central.hoa-project.net/Resource/Library/Compiler) to lex, parse
and produce an AST of the following regular expression: `ab(c|d){2,4}e?`. Thus:
@@ -76,7 +109,7 @@ two tokens: `c` and `d`, between 2 to 4 times. The second quantification is the
`e` token that can appear zero or one time.
We can visit the tree with the help of the [`Hoa\Visitor`
### Generate strings based on regular expressions
@@ -97,10 +130,35 @@ Strings are generated at random and match the given regular expression.
## Documentation
-Different documentations can be found on the website:
+[hack book of `Hoa\Regex`](https://central.hoa-project.net/Documentation/Library/Regex)
+contains detailed information about how to use this library and how it works.
+To generate the documentation locally, execute the following commands:
+$ composer require --dev hoa/devtools
+$ vendor/bin/hoa devtools:documentation --open
+More documentation can be found on the project's website:
+## 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
+Hoa is under the New BSD License (BSD-3-Clause). Please, see
+[`LICENSE`](https://hoa-project.net/LICENSE) for details.