forked from witten/novel-stats
Add some rationales/motivations.
This commit is contained in:
parent
68508bcb2f
commit
1b486d4d69
21
README.md
21
README.md
|
@ -1,8 +1,13 @@
|
||||||
novel-stats produces word count statistics for novels written in Markdown
|
novel-stats produces word count statistics for novels written in Markdown
|
||||||
format, including total word count, per-chapter word counts, per-act word
|
format, including total word count, per-chapter word counts, per-act word
|
||||||
counts, and counts by chapter "status." It's fairly particular about the
|
counts, and counts by chapter "status." You might find this useful if you're
|
||||||
format of the novel, and doesn't currently include much in the way of error
|
already using tools like Git and Markdown processing as part of your writing
|
||||||
checking. Word counts may not be exact.
|
workflow (or are looking to start) and want some basic statistics about your
|
||||||
|
novel as you're writing it.
|
||||||
|
|
||||||
|
novel-stats fairly particular about the format of the novel, and doesn't
|
||||||
|
currently include much in the way of error checking. Word counts may not be
|
||||||
|
exact.
|
||||||
|
|
||||||
Example output:
|
Example output:
|
||||||
|
|
||||||
|
@ -80,7 +85,10 @@ Once upon a time ...
|
||||||
|
|
||||||
Chapter "status" is an optional feature that lets you indicate certain
|
Chapter "status" is an optional feature that lets you indicate certain
|
||||||
chapters as "drafted", "dev edited", etc. and then get word count totals for
|
chapters as "drafted", "dev edited", etc. and then get word count totals for
|
||||||
each status. Example:
|
each status. This is useful for tracking the progress of your novel
|
||||||
|
chapter-by-chapter as you write or revise.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
## 3
|
## 3
|
||||||
|
@ -100,7 +108,10 @@ sense for your writing workflow.
|
||||||
### Acts
|
### Acts
|
||||||
|
|
||||||
Acts are an optional feature that let you indicate certain chapters as part of
|
Acts are an optional feature that let you indicate certain chapters as part of
|
||||||
a particular act number, and then get word count totals for each act. Example:
|
a particular act number, and then get word count totals for each act. This is
|
||||||
|
useful for keeping an eye on how big your acts are in relation to one another.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
## 8
|
## 8
|
||||||
|
|
Loading…
Reference in New Issue