Smith Dhumbumroong avatar Smith Dhumbumroong committed 80a788f

Greatly expand the readme

Comments (0)

Files changed (1)

 # PyCGA
 
-PyCGA is a simple implementation of Compact Genetic Algorithm (cGA) written in Python. It implements a simple OneMax fitness function and a trap-5, as well as a (very simple and very biased) method of solving the said trap. PyCGA can also plot simple graphs showing how the fitness score and the state of each member inside the probability vector change as our algorithm "evolves" through generations. 
+PyCGA is a simple implementation of Compact Genetic Algorithm (cGA) written in Python for educational purposes. It implements a simple OneMax fitness function and a trap-5, as well as a (very simple and very biased) method of solving the said trap. PyCGA can also plot simple graphs showing how the fitness score and the state of each member inside the probability vector change as our algorithm "evolves" through generations. 
 
 ## Dependencies
 
-- [matplotlib] [3] for graph plotting
+- [Python] [5] version 2.7.3 or any later version in the Python 2.7 series
+- [matplotlib] [3] (optional) for graph plotting
+
+## Usage
+
+Just invoke PyCGA in your favorite terminal emulator like the following examples:
+    
+    python PyCGA.py
+
+or
+
+    ./PyCGA.py
+
+should be more than enough to start PyCGA with the default parameters.
+
+For more information, such as how to change various parameters of PyCGA, please see PyCGA's help, which can be shown using the following commands:
+
+    python PyCGA.py --help
+
+or
+
+    ./PyCGA.py --help
 
 ## References
 
 [2]: http://www.cleveralgorithms.com/nature-inspired/probabilistic/compact_genetic_algorithm.html
 [3]: http://matplotlib.org
 [4]: http://www.cleveralgorithms.com
+[5]: http://www.python.org
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.