Update readme. Remove automatic installation of levenshtein for fuzzywuzzy.
This commit is contained in:
parent
670dac5c1b
commit
3e8447f492
|
@ -1,4 +1,4 @@
|
||||||
# Daily Releases: *A reddit bot that consolidates scene releases*
|
# Daily Releases
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
### Installation
|
### Installation
|
||||||
|
@ -10,11 +10,13 @@ pip3 install --upgrade https://git.caspervk.net/caspervk/dailyreleases/archive/m
|
||||||
|
|
||||||
**It requires Python 3.6 or later.**
|
**It requires Python 3.6 or later.**
|
||||||
|
|
||||||
|
To speed up fuzzy string matching, it may be desirable to install `python3-levenshtein`.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
The program can be started by running `dailyreleases` or `python3 -m dailyreleases` depending on system configuration.
|
The program can be started by running `dailyreleases` or `python3 -m dailyreleases` depending on system configuration.
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
The default configuration file will be copied to `~/.dailyreleases/config.ini` on the first run. All fields under the
|
The default configuration file will be copied to `~/.dailyreleases/config.ini` on the first run. All fields under the
|
||||||
[reddit] and [google] sections need to be filled out before the bot can be initialized.
|
`[reddit]` and `[google]` sections need to be filled out before the bot can be initialized.
|
||||||
|
|
||||||
To append content to the generated post, add a file `~/.dailyreleases/epilogue.txt`.
|
To append content to the generated post, add a file `~/.dailyreleases/epilogue.txt`.
|
Reference in a new issue