Create README.md

README.md

@@ -0,0 +1,25 @@
+# dircomp
+## Name
+dircomp - A directory comparison tool
+
+## Synopsis
+`dircomp directory1 directory2 [-r] [-v] [-h]`
+
+## Description
+dircomp is a program for evaluating wether two directories are equivalent.
+
+Two directories are equivalent if and only if these conditions apply:
+* They have the same number of files and folders;
+* For each file in a directory, there is the same file in the other. Two files are considered to be the same 
+if they have the same name, including extension, and same content, evaluated through a checksum.
+* For each folder in a directory, there is a folder with the same name in the other.
+
+If the recursive option is applied, then another condition must hold true:
+* For each folder in a directory, there is an equivalent folder in the other, with the same name.
+
+The options are as follows:
+```
+  -r             Recursive
+  -v             Verbose
+  -h             Print this help and quit
+```