Documentation updates and file renaming for consistency

Makefile

@@ -24,19 +24,19 @@ dist:
 	@echo "Copying Configuration and includes"
 	mkdir -p build/config
 	mkdir -p build/includes
-	cp src/config/retry_config.asm build/config/retry_config.asm
+	cp src/config/quickretry_config.asm build/config/quickretry_config.asm
 	cp src/includes/hardware_registers.asm build/includes/hardware_registers.asm
 	cp src/includes/rammap.asm build/includes/rammap.asm
 
 	@echo "Copying sources"
-	cp src/retry_system.asm build/retry_system.asm
+	cp src/quickretry.asm build/quickretry.asm
 
 	@echo "Creating archive"
 	cd build; tar cvzf ../quickretry-$(VERSION).tgz *
 	cd build; zip -r ../quickretry-$(VERSION).zip *
 
 patch:
-	@echo "Patching SMW..."
+	@echo "Patching original SMW..."
 	cd src; $(ASAR_BIN) retry_system.asm $(ORIGINAL_ROM) ../original-patched.smc
 	@echo "Patching Reference SMC"
 	cd src; $(ASAR_BIN) retry_system.asm $(REFERENCE_ROM) ../reference-patched.smc

README.md

@@ -1,12 +1,12 @@
-Quick Retry System 1.0
+Quick Retry System 1.2
 ======================
-
  This patch adds a quick retry option to Super Mario World for the SNES. It has been written for simplicity and best
-effort has been made to provide a thorough documentation of the source.
+effort has been made to provide a thorough documentation of the source. 
 
- Using this patch you can give the player a choice to Retry or exit the level, default to exit or instant retry, either
+ Using this patch you can give the player a choice to retry or exit the level, default to exit or instant retry, either
 globally or on a per level basis. Additionally, SELECT+START can be enabled to exit a level. You can optionally deactivate
-the deduction of lives upon death, and define sound effects and message popup options.
+the deduction of lives upon death, and define sound effects and message popup options. Finally, you have a choice for
+resetting the RNG upon death, trying to ensure the same RNG ocurring on every run.
 
 The patch uses variable names equal or at least similar to those used in SMWDisX created by dotsarecool for reference.
 
@@ -18,30 +18,56 @@ modifications to that repository. Pull requests are welcome!
 This code is a rewrite/update/fork of Retry- System (+ Simple Multi Midway) by worldpeace.
 
 
+Requirements:
+=============
+ To use this patch, a version of SMW is required. To apply the patch ASAR version >= 1.6 is required. ASAR can be found
+here: https://github.com/RPGHacker/asar
+
+ To participate in development, a version of Linux is recommended. Release packaging is done via Makefiles, and tested
+under Linux only.
+
+
 Configuration and installation from a release version
 =====================================================
+The most current version can be downloaded from here: 
+
+https://github.com/DevLaTron/smw-quickretry/releases
+
+You only need this download to patch your ROM.
 
 1. Backup your ROM file to a safe place.
-2. Edit the file config/retry_config.asm to fit your needs. See the comments for explanations.
-3. Apply the patch to your ROM: asar retry.asm [your_rom.smc]
+2. Edit the file config/quickretry_config.asm to fit your needs. See the comments for explanations.
+3. Apply the patch to your ROM: asar quickretry.asm [your_rom.smc]
 
 
 Configuration and building from GITHUB
 ======================================
+Use this if you want to contribute or extend Quick Retry. Check out / clone a copy of the repository found here:
+
+https://github.com/DevLaTron/smw-quickretry.git
+
 1. Edit and configure common.mk to fit your needs.
-2. Add SMW ROMS to an appropriate directory.
-3. Run "make patch" to create patched ROMs for testing.
+2. Add SMW ROMS to an appropriate directory. This allows you to use make to patch and compare your code changes.
+3. Run "make patch" to create patched ROMs for testing. You can then use the patched ROMs in an emulator for testing.
 4. Run "make dist" to create a release package.
 
 
 Changelog
 =========
 
-Version 1.0 2018-10-13
+Version 1.2 2018-10-XX
+----------------------
+- Renamed ASM files to better reflect package structure and naming.
+- Update README.md to better reflect some details.
+- Updates to Makefiles.
+- Corrected versioning.
+- Updates to code documentation.
+- Added MD5 checksums for testing and comparison ROMs.
+
+Version 1.1 2018-10-13
 ----------------------
 - First public release on GITHUB.
 
 Version 0.1 2018-09-20
 ----------------------
 - Initial version, not for public use.
-

common.mk

@@ -1,12 +1,12 @@
-VERSION=1.1
+VERSION=1.2
 # Where is your ASAR binary? You need at least version 1.62
 ASAR_BIN=../../asar/asar/asar-standalone
 
-# Path to an original version of SMW
+# Path to an original version of SMW, MD5: dbe1f3c8f3a0b2db52b7d59417891117
 ORIGINAL_ROM = ../originals/smw-original.smc
 
-# Path to a reference ROM for comparison
+# Path to a reference ROM for comparison (Golden Mushroom v3.1), MD5: dbe1f3c8f3a0b2db52b7d59417891117
 REFERENCE_ROM = ../originals/smw-reference.smc
 
-# Uses Kaizo Consistency ROM Hack for testing
+# Uses Kaizo Consistency ROM Hack for testing, MD5: 5443a6a417cc7b3acd893ade40794232
 KAIZO_ROM = ../originals/kaizo-consist-original.smc

src/retry_system.asm → src/quickretry.asm

@@ -99,7 +99,7 @@ ORG $05D8E0
 freecode
 ; Load configuration from extra file.
 Config:
-	incsrc config/retry_config.asm
+	incsrc config/quickretry_config.asm
 
 InjectPromptCode:
         ; Add inject to custom retry prompt code