Project needs a README

[djmattyg007]

It's very difficult to tell what this package is for because of the total lack of explanation.

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[Hywan]

You're correct :-). I will try to write one the next days. Thanks!

[Hywan]

hoaproject/Praspel#22 has been merged, so now we can address this issue!

[lcetinsoy]

Hello !
I wanted to open "documentation love" issues but there is already one here :)

I am playing with the various Hoa libraries related to Praspel in order to understand the various pieces. Some love would be very nice for this repository and I will push a PR soon with some tweaks on Readmes if you are ok.

I would like to edit a Read.me for the Realdom and Praspel repositories and add the following :

1. An "usage section" with some code examples as my Machine learning background makes me believe that "humans learn by induction" :)
2. Add a "use case section" or "a motivation section".

For RealDom it could say "This repo can be used to implement a data generator library like php faker or simply enrich your unit tests with more real data. It can also be used for property based testing and be integrated with eris. Currently this repo is used with Praspel for CDD [blabla]"

For Praspel it could say "This library in itself is just a contract specification. But it can be used to build automatic unit tests based on contracts for any unit libraries. A pluging exists for atoum. It can also be used to verify contracts at run times in your application like "classic CDD".

Having some use case will make people see easily what can be the uses of both libraries. Of course, I will try to have a better wording : )

Here are a few first questions :

• Is it ok if I keep one unique issue for both Praspel and Realdom, or you really prefer me to open a second one in Praspel repo for it ?

• I understood that the Praspel class can parse a comment into a Specification class. If i am not wrong the repo do not gives a method to extract all Annotations of a method / class and we have to rely either on Reflection or some doctrine/annotation lib, right ?

More questions coming soon probably !

Best,
Laurent