aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkartofen <mladenovnasko0@gmail.com>2022-08-24 21:01:33 +0300
committerkartofen <mladenovnasko0@gmail.com>2022-08-24 21:01:33 +0300
commit4dd7d65361e906228e961bc55092a96cd7e3efe1 (patch)
tree2d444f48aad4986aef7448771b9f473d2d916cef
parente25536a4df3e6ffaa80abdcb34df2382213a725a (diff)
edit readme
-rw-r--r--README.md16
-rwxr-xr-xbuild.sh2
2 files changed, 16 insertions, 2 deletions
diff --git a/README.md b/README.md
index f138b07..9a077d9 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
### Markov Chains
-This is a simple implementation of markov chains
+This is a simple implementation of markov chains.
+An example chain could be generated with bin/gen_chain.
+The main program expect a file specified in src/main.c (default is files/in.txt).
+The program generates a markov chain using the file.
+Output and other things can be tweaked with the macros in the files.
### Build
@@ -10,3 +14,13 @@ to build and run use
``` ./build.sh run ```
See the build.sh file for more info
+
+### Limitations
+
+Limitations of the output:
+1. No upper case letters (who needs them anyway)
+2. No proper punctuation (who needs punctuation anyway), just words
+
+Limitations of processing input:
+1. The symbols: `[]"",` are completely ignored,
+`.` and `\n` are used to identify end of thought (sentance)
diff --git a/build.sh b/build.sh
index f1befea..46f2dc0 100755
--- a/build.sh
+++ b/build.sh
@@ -34,6 +34,6 @@ gcc -o $BIN/gen_chain $FLAGS $SRCD/gen_chain.c
if ! { [[ $RUN -eq 0 ]]; } 2> /dev/null
then
- $BIN/gen_chain
+ # $BIN/gen_chain
$BIN/main
fi