add some comments for testcases

Signed-off-by: lifubang <[email protected]>

Author: lifubang

README.md

@@ -1,5 +1,12 @@
 ## ACMDiffer
 ```
+This is a core module used by ACMCoder OJ.
+It's used to compare the user's out and the test case.
+```
+
+## How to make and test
+```
+go test github.com/acmcode/differ/tool
 make
 ./acmdiffer testdata/step.judger/user.out testdata/step.judger/data.out false false
 ./acmdiffer testdata/step.judger/user.out testdata/step.judger/datav5.out false false
@@ -17,4 +24,18 @@ userOut: user's output file
 dataOut: the test case file
 diffIgnoreHead: ignore the first line when comparing the contents
 strictMode: whether ignore the space and enter key or not when comparing the contents
-```
+```
+
+## Special test cases
+```
+TestDiffOutV2 is to ignore the space when comparing
+TestDiffOutV5 is to ignore the enter key when comparing
+Welcome some other special test cases.
+```
+
+## TODO
+```
+implement the strict mode
+```
+
+Welcome send issues or PRs.

tool/differ_test.go

@@ -37,6 +37,7 @@ func TestDiffOutV1(t *testing.T) {
 	}
 }
 
+// TestDiffOutV2 is to ignore the space when comparing
 func TestDiffOutV2(t *testing.T) {
 	path, err := filepath.Abs(".")
 	if err != nil {
@@ -85,6 +86,7 @@ func TestDiffOutV4(t *testing.T) {
 	}
 }
 
+// TestDiffOutV5 is to ignore the enter key when comparing
 func TestDiffOutV5(t *testing.T) {
 	path, err := filepath.Abs(".")
 	if err != nil {