Fixed mistake in readme
This commit is contained in:
parent
44426edb78
commit
9fb1025a02
34
README.md
34
README.md
|
@ -33,24 +33,10 @@ dev edited: 82 words (~15%)
|
||||||
total: 539 words
|
total: 539 words
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installation
|
Example with multi-file markdown:
|
||||||
|
|
||||||
Start by cloning the project with git. Then install it with Python's `pip`.
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip3 install /path/to/novel-stats
|
$ novel-stats multi_file.mdpp -pp -c -a
|
||||||
```
|
|
||||||
|
|
||||||
Or, if you'd like to install it "editable" (making development/updates
|
|
||||||
easier):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip3 install --editable /path/to/novel-stats
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash
|
|
||||||
novel-stats multi_file.mdpp -pp -c -a
|
|
||||||
chapter 1 Lorem:
|
chapter 1 Lorem:
|
||||||
203 (drafted)
|
203 (drafted)
|
||||||
303 (dev edited)
|
303 (dev edited)
|
||||||
|
@ -69,6 +55,22 @@ dev edited: 385 words (~40%)
|
||||||
total: 946 words
|
total: 946 words
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Start by cloning the project with git. Then install it with Python's `pip`.
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip3 install /path/to/novel-stats
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, if you'd like to install it "editable" (making development/updates
|
||||||
|
easier):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip3 install --editable /path/to/novel-stats
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
novel-stats takes a single argument: The path to your novel file in markdown
|
novel-stats takes a single argument: The path to your novel file in markdown
|
||||||
|
|
Loading…
Reference in New Issue