Rename README to README.md. Turn out that GitHub doesn't render README as Markdown if .md extension is missing.

Author: MapleCCC

Makefile

@@ -83,7 +83,7 @@ pdf:
 	pandoc -s -o README.assignment.pdf README.assignment.md
 
 transform-eqn:
-	python3 ${SCRIPTS_DIR}/eqn2imgurl.py README.raw.md -o README
+	python3 ${SCRIPTS_DIR}/eqn2imgurl.py README.raw.md -o README.md
 
 # TODO
 release:

README renamed to README.md

@@ -59,9 +59,9 @@ The pre-commit hook script basically does two things:
 
 1. Format staged C/C++ code
 
-2. Transform LaTeX math equation in `README.raw.md` to image url in `README`
+2. Transform LaTeX math equation in `README.raw.md` to image url in `README.md`
 
-Besides relying on the pre-commit hook script, you can manually format code and transform math equations in README
+Besides relying on the pre-commit hook script, you can manually format code and transform math equations in README.md
 
 ```bash
 make reformat

README.raw.md

@@ -59,9 +59,9 @@ The pre-commit hook script basically does two things:
 
 1. Format staged C/C++ code
 
-2. Transform LaTeX math equation in `README.raw.md` to image url in `README`
+2. Transform LaTeX math equation in `README.raw.md` to image url in `README.md`
 
-Besides relying on the pre-commit hook script, you can manually format code and transform math equations in README
+Besides relying on the pre-commit hook script, you can manually format code and transform math equations in README.md
 
 ```bash
 make reformat

TODO.md

@@ -70,7 +70,7 @@
 - Improve CLI interface to be more user-friendly and intuitive.
 - Write README. Elaborate on algorithmic details. Elaborate on analysis of computational complexity.
 - Add git tag "submission milestone"
-- Customize commit hook: process README.raw.md to README with all latex equation transformed to images.
+- Customize commit hook: process README.raw.md to README.md with all latex equation transformed to images.
 - Add Travis CI pipeline. Automatically compile and test.
 - Create script to replace LaTeX math text with image url. For render in GitHub.
 

scripts/pre-commit.py

@@ -2,7 +2,7 @@
 
 # This pre-commit hook script basically does two things:
 # 1. Format staged C/C++ code
-# 2. Transform LaTeX math equation in README.raw.md to image url in README
+# 2. Transform LaTeX math equation in README.raw.md to image url in README.md
 
 # TODO: search in google with query: "git status machine readable"
 
@@ -89,15 +89,15 @@ def main():
     except CalledProcessError:
         raise RuntimeError("Format staged C/C++ code failed!")
 
-    # 2. Transform LaTeX math equation in README.raw.md to image url in README
+    # 2. Transform LaTeX math equation in README.raw.md to image url in README.md
     try:
         if "README.raw.md" in filepaths:
             subprocess.run(
-                ["python", "scripts/eqn2imgurl.py", "README.raw.md", "-o", "README"],
+                ["python", "scripts/eqn2imgurl.py", "README.raw.md", "-o", "README.md"],
             ).check_returncode()
-            subprocess.run(["git", "add", "README"]).check_returncode()
+            subprocess.run(["git", "add", "README.md"]).check_returncode()
     except CalledProcessError:
-        raise RuntimeError("Transform math equation to image url in README failed!")
+        raise RuntimeError("Transform math equation to image url in README.md failed!")
 
 
 if __name__ == "__main__":