Changed README to Markdown and added some information to it

2 years ago · 5ab7074d9a
parent cb8b9d0b2d
commit 5ab7074d9a
2 changed files with 13 additions and 5 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,13 @@
+# Mirror Checker
+
+This mirror status checker determines whether CSC mirror is up-to-date with upstream.
+
+## How To Run
+
+Run `main.py`.
+
+## Resources
+
+- [CSC Mirror](http://mirror.csclub.uwaterloo.ca/)
+- [Debian Mirror Status Checker](https://mirror-master.debian.org/status/mirror-status.html)
+- [Debian Mirror Status Checker Code](https://salsa.debian.org/mirror-team/mirror/status)
--- a/README.txt
+++ b/README.txt
@ -1,5 +0,0 @@
-
-Resources:
-http://mirror.csclub.uwaterloo.ca/
-https://mirror-master.debian.org/status/mirror-status.html
-https://salsa.debian.org/mirror-team/mirror/status