Add README

This commit is contained in:
Gabriel Augendre 2016-04-18 17:48:51 +02:00
parent 0d8ebd5f4b
commit 32245ccfeb
No known key found for this signature in database
GPG Key ID: D2B6A5B41FC438B1
1 changed files with 18 additions and 0 deletions

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Name Picker
## Requirements
This project requires __Java 8__
## Description
This program helps you pick a name from a list according to some conditions. An example list that comes from the [French Government Open Data](https://www.data.gouv.fr/fr/datasets/liste-des-prenoms-par-annee-prs/) is included.
### Conditions
For the moment, the conditions are :
- 6 letters. No more, no less.
- No H.
- Not ending with an A.
- Alternate vowels and consonant.
- No repeated letter.
- Exactly one B, or M, or P.
Next releases are expected to implement a GUI for defining your own conditions.