diff --git a/src/README.md b/src/README.md index 079c20b..ccb44ef 100644 --- a/src/README.md +++ b/src/README.md @@ -1 +1,25 @@ -# Main functions +### To run from the downloaded source code +run.py + +#### Main functionality files +EasyGA.py +attributes.py + +#### Decorators used to simply code +decorators.py + +#### Genetic Algorithm process +crossover/ +mutation/ +parent/ +survivor/ +termination/ + +#### Building blocks +structure/ + +#### Fitness functions +fitness_examples/ + +#### Testing +test_EasyGA.py