amr/discorss
amr/discorss
1
2
Fork 0
Code Issues Pull requests Projects Releases 4 Packages Wiki Activity Actions

readme: fix small error

Browse source
This commit is contained in:
A.M. Rowsell 2026-04-25 22:40:17 -04:00
commit 4128e7808c
Signed by: amr
GPG key ID: E0879EDBDB0CA7B1
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -15,7 +15,7 @@ The remaining imports should all be part of the standard Python install: hashlib
## Important Notes
By default, DiscoRSS will try and put the logs in `/var/log/discorss`. Make sure to create this directory and give the user running the script write permissions there. If you want the logs to go somewhere else, just give the directory as an argument (shown below). Choose a directory that makes sense. Unfortunately, as far as I know, the XDG standards don't have an equivalent to the /var/log directory in the user directory, so I wasn't sure what the best default was. In the future, we may switch to logging using systemd and journald directly, though it is nice to have a separate file.
By default, DiscoRSS will try and put the logs in `/var/log/discorss`. Make sure to create this directory and give the user running the script write permissions there. If you want the logs to go somewhere else, just give the path as an argument (shown below). Choose a directory that makes sense. Unfortunately, as far as I know, the XDG standards don't have an equivalent to the /var/log directory in the user directory, so I wasn't sure what the best default was. In the future, we may switch to logging using systemd and journald directly, though it is nice to have a separate file.
### Script Arguments
@ -23,7 +23,7 @@ The script has a few different arguments that make it easy to customize certain
* `-d / --dry-run`: Just like it says on the tin -- run the script, pull feeds, but don't post anything to Discord
* `-c / --config-file`: Give a path to an alternate location for the config file. The default is ~/.config/discorss/discorss.conf and that should be fine for the vast majority of users.
* `-l / --log-file`: Give a path to where you want the log file stored. The default is /var/log/discorss/app.log but you will have to create the /var/log/discorss directory (or have install.sh do it for you) and make it writeable by whatever user will be running the script.
* `-l / --log-file`: Give a path to where you want the log file stored. The default is /var/log/discorss/app.log but you will have to create the /var/log/discorss directory and make it writeable by whatever user will be running the script.
## How to setup