Added READMEs to all folders

Author: markmoxon

1-source-files/basic-programs/README.md

@@ -0,0 +1,15 @@
+# BASIC programs for the BBC Micro disc version of Revs
+
+This folder contains the BASIC programs from the BBC Micro disc version of Revs.
+
+* [$.MENU.bin]($.MENU.bin) shows the loading screen and track menu for the 1985 Revs 4 Tracks release
+
+* [$.REVS.bin]($.REVS.bin) shows the loading screen for the original 1985 Acornsoft release
+
+* [$.REVSMEN.bin]($.REVSMEN.bin) shows the loading screen and track menu for the 1986 Superior Software release
+
+* [$.REVSPLUS.bin]($.REVSPLUS.bin) shows the game menu for the Revs Plus release
+
+---
+
+_Mark Moxon_

1-source-files/boot-files/README.md

@@ -0,0 +1,13 @@
+# Boot files for the BBC Micro disc version of Revs
+
+This folder contains the boot file from the BBC Micro disc version of Revs.
+
+* [$.!BOOT.bin]($.!BOOT.bin) is the boot file from the original 1985 Acornsoft game disc, which runs $.REVS
+
+* [$.!BOOT2.bin]($.!BOOT2.bin) is the boot file from the 1985 Revs 4 Tracks game disc, which runs $.MENU
+
+* [$.!BOOTS.bin]($.!BOOTS.bin) is the boot file from the 1986 Superior Software game disc, which runs $.REVSMEN
+
+---
+
+_Mark Moxon_

1-source-files/images/README.md

@@ -0,0 +1,13 @@
+# Image binaries for the BBC Micro disc version of Revs
+
+This folder contains the image binaries from the BBC Micro disc version of Revs.
+
+* [$.5TRSCRN.bin]($.5TRSCRN.bin) is the mode 7 loading screen for the 1986 Superior Software release
+
+* [$.PLUSCRN.bin]($.PLUSCRN.bin) is the mode 7 loading screen for Revs Plus
+
+* [dashboard.bin](dashboard.bin) is the dashboard image for the car in-game
+
+---
+
+_Mark Moxon_

1-source-files/main-sources/README.md

@@ -0,0 +1,33 @@
+# Annotated source code for the BBC Micro disc version of Revs
+
+This folder contains the annotated source code for the BBC Micro disc version of Revs.
+
+* Main source files:
+
+  * [revs-source.asm](revs-source.asm) contains the main source for the game
+
+  * [revs-brandshatch.asm](revs-brandshatch.asm) contains the track data for Brands Hatch
+
+  * [revs-doningtonpark.asm](revs-doningtonpark.asm) contains the track data for Donington Park
+
+  * [revs-nurburgring.asm](revs-nurburgring.asm) contains the track data for the Nürburgring
+
+  * [revs-oultonpark.asm](revs-oultonpark.asm) contains the track data for Oulton Park
+
+  * [revs-silverstone.asm](revs-silverstone.asm) contains the track data for Silverstone
+
+  * [revs-snetterton.asm](revs-snetterton.asm) contains the track data for Snetterton
+
+* Other source files:
+
+  * [revs-loader.asm](revs-loader.asm) contains the source for the loader
+
+  * [revs-disc.asm](revs-disc.asm) builds the SSD disc image from the assembled binaries and other source files
+
+* Files that are generated during the build process:
+
+  * [revs-build-options.asm](revs-build-options.asm) stores the make options in BeebAsm format so they can be included in the assembly process
+
+---
+
+_Mark Moxon_

1-source-files/text-files/README.md

@@ -0,0 +1,9 @@
+# BASIC programs for the BBC Micro disc version of Revs
+
+This folder contains the text files from the BBC Micro disc version of Revs.
+
+* [READMEPLUS.bin](READMEPLUS.bin) is the README file for Revs Plus on the BBC Micro
+
+---
+
+_Mark Moxon_

2-build-files/revs-checksum.py

@@ -44,7 +44,7 @@
 
     for i in range(0, 4):
         checksum[i] = checksum[i] % 256
-        print("Commander checksum", i, "=", hex(checksum[i]))
+        print("Track data checksum", i, "=", hex(checksum[i]))
         data_block[checksum_offset + i] = checksum[i]
 
     # Write updated track

3-assembled-output/README.md

@@ -2,6 +2,8 @@
 
 This folder contains the output binaries from the build process for the BBC Micro disc version of Revs.
 
+It also contains [compile.txt](compile.txt), which contains the output from the assembly process. This is very useful when debugging the build process.
+
 ---
 
 _Mark Moxon_

4-reference-binaries/README.md

@@ -2,6 +2,14 @@
 
 This folder contains the binaries from the game disc for the BBC Micro disc version of Revs, as well as reference binaries for the other releases.
 
+* [acornsoft](acornsoft) contains the binaries from the original 1985 Acornsoft release
+
+* [4tracks](4tracks) contains the binaries from the 1985 Revs 4 Tracks release
+
+* [superior](superior) contains the binaries from the 1986 Superior Software release
+
+* [revsplus](revsplus) contains the binaries from a new release of Revs Plus that includes the Nürburgring track, backported from the Commodore 64 version
+
 ---
 
 _Mark Moxon_