summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpommicket <leonardomtenenbaum@gmail.com>2016-01-31 16:34:48 -0500
committerpommicket <leonardomtenenbaum@gmail.com>2016-01-31 16:34:48 -0500
commitaf7f282e0bc7eb5f697d7e5a619a3e56032e58c5 (patch)
treeb81885046958b8b14d5fcf9a7c8e2d0eb29f3d00
parentd4a307247515a89fa9946ba76d6b7c39e790eb27 (diff)
parent42dbea2bd4f874f97558ab6dacd7ea428013012b (diff)
Merge branch 'master' of https://github.com/pommicket/StringLearn
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md
index b4ad777..0f9b942 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,51 @@
# StringLearn
Rate strings, and then generate new ones using those ratings.
+
+StringLearn works by keeping track of the frequencies of n-grams.
+
+Executables can be found in the build directory, but if you want to compile the source code, just run `make` in the src directory.
+
+
+**Windows**
+Creating a string with a *.stl file:
+```bash
+cd StringCreate/build/Windows
+StringCreate <stlfile> [--stopX] -l <minlengthorlength> [-p newNgramChance]
+```
+For documentation, run:
+```bash
+StringCreate --help
+```
+Rating the string, and saving the rating to a *.stl file:
+```bash
+cd build/Windows
+StringLearn <string> -r <rating> -s <stlfile>
+```
+For documentation, run:
+```bash
+StringLearn --help
+```
+
+
+**GNU/Linux**
+Creating a string with a *.stl file:
+```bash
+cd StringCreate/build/GNULinux
+./StringCreate <stlfile> [--stopX] -l <minlengthorlength> [-p newNgramChance]
+```
+For documentation, run:
+```bash
+./StringCreate --help
+```
+Rating the string, and saving the rating to a *.stl file:
+```bash
+cd build/GNULinux
+./StringLearn <string> -r <rating> -s <stlfile>
+```
+For documentation, run:
+```bash
+./StringLearn --help
+```
+
+
+Mac OS X is not supported.