From 0ca5c0153fa09b52af2eacab921e026a42181705 Mon Sep 17 00:00:00 2001 From: pommicket Date: Sun, 31 Jan 2016 16:45:22 -0500 Subject: Edited readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 866f6b9..6315050 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # NameGeneratorEvolve Creates names, asks you to rate them, and slowly learns which names are good. + +NameGeneratorEvolve uses [StringLearn](https://github.com/pommicket/StringLearn) look at the n-grams you like, to determine which names you like. + +Executables can be found in the build directory, but if you want to compile the source code, just run `make` in the src directory. + +**The names evolve *very* slowly. They start out completely random.** + +**Windows** +```bash +cd build/Windows +NameLearn +``` + +**GNU/Linux** +```bash +cd build/GNULinux +./NameLearn +``` + +Mac OS X is not supported. -- cgit v1.2.3