From ea0655bbb0295a9ca837272100be7f2d8bc50116 Mon Sep 17 00:00:00 2001 From: mouse Date: Mon, 20 Apr 2020 21:42:00 -0300 Subject: [PATCH] typos --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bd417a9..5a19704 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -## disclaimer: +## disclaimer i wrote this cli rapper for the `markovify` python module because i wanted its features to be available as a cli tool. @@ -17,7 +17,7 @@ a second command, `mkv-this-dir` (see below) allows you to input a directory and `mkv-this` simply makes some of the features of the excellent `markovify` python module available as a command line tool. it was written by a total novice, so you probably shouldn’t download it. i only learned about `argparser` yesterday, and pypi.org today, no matter what day it is. tomorrow i might learn about `os` and `sys`. and then maybe even `cookiecutter`! -### installing: +### installing install it with `pip`, the python package manager: @@ -33,6 +33,8 @@ to do this you need `python3` and `pip`. if you don't have them, install them th `markovify` is also a dependency, but it should install along with `mkv-this`. +if you get sth like `ModuleNotFound error: No module named 'modulename'`, just run `pip install modulename` to get it. + ### repository if you are reading this on pypi.org, the repo is here: @@ -48,7 +50,7 @@ you can check if `pip` is installed with `pip --version`, or `pip3 --version`. i know nothing about macs so if you ask me for help i'll just send you random copypasta from the interwebs. -### options: +### options the script implements a few of the basic `markovify` options, so you can: @@ -75,11 +77,11 @@ if for some reason you want to get a similar funtionality with `mkv-this`, you c * run mkv-this on your newly created file: `mkv-this outputfile.txt` * this approach has the benefit of creating a file with encoding that mkv-this can certainly handle. -### file types accepted: +### file types you need to input plain text files. currently accepted file extensions are `.txt`, `.org` and `.md`. it is trivial to add others, so if you want one included just ask. -### for best results: +### for best results feed `mkv-this` large-ish amounts of well punctuated text. it works best if you bulk replace/remove as much mess as possible (URLs, metadata, stars, bullets, etc.), unless you want mashed versions of those things in your output.