From ff451639e93a3ac11fb0268b92bc0cffc00bfdbe Mon Sep 17 00:00:00 2001 From: accraze Date: Sat, 26 Nov 2016 17:14:06 -0800 Subject: [PATCH] docs(README): added quickstart info --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index f1134f0..64282ed 100644 --- a/README.rst +++ b/README.rst @@ -73,6 +73,23 @@ Installation pip install markov-novel +Quick Start +=========== + +:: + + import markovify + import markov_novel + + with open('path/to/corpus.txt') as f: + text = f.read() + # Build the model. + text_model = markovify.Text(text) + novel = markov_novel.Novel(text_model, chapter_count=1) + novel.write(novel_title='my-novel', filetype='md') + +The novel will be written to your current working directory. + Documentation =============