From 32245ccfebc014efdbe4ec45e48f5d6279e6b340 Mon Sep 17 00:00:00 2001
From: Gabriel Augendre <gabriel@augendre.info>
Date: Mon, 18 Apr 2016 17:48:51 +0200
Subject: [PATCH] Add README

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9527a7d
--- /dev/null
+++ b/README.md
@@ -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.