Add a comment to the "compare" target.

anthonycicc · Jul 16, 2014 · 8dd4662 · 8dd4662
1 parent 4ad367b
commit 8dd4662
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -27,9 +27,15 @@ PYTHON := python
 
 # md5sum -c is used to compare rom hashes. The options may vary across platforms.
 MD5 := md5sum -c --quiet
+
+
+# The compare target is a shortcut to check that the build matches the original roms exactly.
+# This is for contributors to make sure a change didn't affect the contents of the rom.
+# More thorough comparison can be made by diffing the output of hexdump -C against both roms.
 compare:
 	@$(MD5) roms.md5
 
+
 # Clear the default suffixes.
 .SUFFIXES:
 .SUFFIXES: .asm .tx .o .gbc .png .2bpp .1bpp .pic