diff --git a/README.md b/README.md index 0b6ffe3..7208f5f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This mirror status checker determines whether CSC mirror is up-to-date with upst A configuration file may be provided through standard input. Without a configuration file, execute `python main.py`. By default, all 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. -## dev notes +## Dev Notes How the program works: We first have a general mirror check class called project.py which checks whether the timestamp in the directory of the mirror is in-sync with the upstream. Then, for each CSC mirror, a class is built which inherits from the general project.py class but often overrides the original check function with a check function specific to the mirror. A few big themes are: some check a mirror status tracker provided by the project mirrored; some check all the Release files for each version in a distro etc. website information which all the mirror checker classes need is stored in the data.json file. @@ -26,9 +26,8 @@ even if the date relies on a specific file in their repo, we can still find the to find repos of the mirrored projects to check, just search "projectName mirrors" -## checker information +## Checker Information -all done: almalinux alpine apache