Add of documentation

README.md

@@ -1,3 +1,28 @@
 # Thesis-OptimizationModules
 
-Optimisation modules built for optimization problem during thesis
+## Description
+
+Optimisation generic framework built for optimization problem during thesis
+
+## Modules
+
+- **algorithms:** generic and implemented OR algorithms
+- **evaluator:** example of an evaluation function to use (you have to implement your own evaluation function)
+- **solutions:** solutions used to represent problem data
+- **updators:** mutators, crossovers update of solution. This folder also had `policies` folder to manage the way of update and use solution.
+  
+**Note:** you can pass a custom `validator` function to the algorithm in order to check is solution is always correct for your needs after an update.
+
+## How to use ?
+
+You can see an example of use in the `mainExample.py` python file.
+
+## Add as dependency
+
+```bash
+git submodule add https://github.com/prise-3d/Thesis-OptimizationModules.git optimization
+```
+
+## License
+
+[The MIT License](LICENSE)

requirements.txt

@@ -0,0 +1 @@
+numpy