Added configuration file to README.md

This commit is contained in:
Laura Nguyen 2021-09-03 17:59:02 -04:00
parent 2ff0b0c69b
commit 4022aedc6c
1 changed files with 2 additions and 2 deletions

View File

@ -4,7 +4,7 @@ This mirror status checker determines whether CSC mirror is up-to-date with upst
## How To Run
Run `main.py`.
A configuration file may be provided through standard input. Without a configuration file, execute `python main.py`. By default, all of the available distributions will be checked. With a configuration file, execute `python main.py < name_of_config_file.in`, for example, `python main.py < example.in`. In this case, only the distributions listed in the configuration file will be checked.
## Resources