From 4dd7d65361e906228e961bc55092a96cd7e3efe1 Mon Sep 17 00:00:00 2001 From: kartofen Date: Wed, 24 Aug 2022 21:01:33 +0300 Subject: edit readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'README.md') 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) -- cgit v1.2.3