witten/novel-stats
1
0
Fork 1
Code Issues 1 Pull Requests Releases Activity

Cleaned up readme

Browse Source
This commit is contained in:
Dmytro Yeroshkin 2021-10-23 14:15:45 +02:00
parent 5df3a48f35
commit 1c28b51916
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -70,7 +70,7 @@ novel-stats takes a single argument: The path to your novel file in markdown
format. For instance:
```bash
novel-stats /path/to/your/novel.md[pp] [-c/--chapter] [-a/--act] [-pp]
novel-stats [-c/--chapter] [-a/--act] [-pp] /path/to/your/novel.md[pp]
```
### Optional flags
@ -78,7 +78,7 @@ novel-stats /path/to/your/novel.md[pp] [-c/--chapter] [-a/--act] [-pp]
* `-c` or `--chapter` — output chapter-by-chapter breakdown of word counts,
including how many words in each chapter are tagged with which status
* `-a` or `--act` — output act-by-act breakdown of word counts (total only)
* `--pp` — run markdown pre-processor, this allows for a multi-file input
* `-pp` — run markdown pre-processor, this allows for a multi-file input
(e.g. each chapter in its own file), but requires the MarkdownPP python
library.