Improved folder structure for build process

Author: markmoxon

1-source-files/README.md

@@ -0,0 +1,15 @@
+# Source file for the BBC Master version of Elite
+
+This folder contains the source files for the BBC Master version of Elite.
+
+* [fonts](fonts) contains the binaries for the game's text font
+
+* [images](images) contains the image binaries for the title screen and dashboard
+
+* [main-sources](main-sources) contains the annotated source code
+
+---
+
+Right on, Commanders!
+
+_Mark Moxon_

binaries/P.FONT.bin renamed to 1-source-files/fonts/P.FONT.bin

@@ -0,0 +1,11 @@
+# Font binaries for the BBC Master version of Elite
+
+This folder contains the font binaries from the original game disc for the BBC Master version of Elite on Ian Bell's personal website.
+
+* P.FONT.bin is the standard BBC Micro font, extracted from the MOS ROM
+
+---
+
+Right on, Commanders!
+
+_Mark Moxon_

1-source-files/fonts/README.md

@@ -1,7 +1,9 @@
-# Extracted binaries for the BBC Master version of Elite
+# Image binaries for the BBC Master version of Elite
 
 This folder contains the image binaries from the original game disc for the BBC Master version of Elite on Ian Bell's personal website.
 
+* P.DIALS2P.bin is the dashboard image
+
 ---
 
 Right on, Commanders!

binaries/P.DIALS2P.bin renamed to 1-source-files/images/P.DIALS2P.bin

@@ -21,11 +21,11 @@
 \
 \ This source file produces the following binary file:
 \
-\   * output/BDATA.bin
+\   * BDATA.bin
 \
 \ ******************************************************************************
 
-INCLUDE "sources/elite-header.h.asm"
+INCLUDE "1-source-files/main-sources/elite-header.h.asm"
 
 CPU 1                   \ Switch to 65SC12 assembly, as this code runs on a
                         \ BBC Master
@@ -75,7 +75,7 @@ ORG CODE%
 
 .DIALS
 
-INCBIN "binaries/P.DIALS2P.bin"
+INCBIN "1-source-files/images/P.DIALS2P.bin"
 
  SKIP 256               \ These bytes appear to be unused, but they get moved to
                         \ &7E00-&7EFF along with the dashboard
@@ -3221,9 +3221,9 @@ ENDMACRO
 IF _MATCH_EXTRACTED_BINARIES
 
 IF _SNG47
- INCBIN "extracted/sng47/workspaces/DATA-align.bin"
+ INCBIN "4-reference-binaries/sng47/workspaces/DATA-align.bin"
 ELIF _COMPACT
- INCBIN "extracted/compact/workspaces/DATA-align.bin"
+ INCBIN "4-reference-binaries/compact/workspaces/DATA-align.bin"
 ENDIF
 
 ELSE
@@ -8928,9 +8928,9 @@ ENDIF
 
 \ ******************************************************************************
 \
-\ Save output/BDATA.unprot.bin
+\ Save BDATA.unprot.bin
 \
 \ ******************************************************************************
 
 PRINT "S.BDATA ", ~CODE%, " ", ~P%, " ", ~LOAD%, " ", ~LOAD%
-SAVE "output/BDATA.unprot.bin", CODE%, P%, LOAD%
+SAVE "3-assembled-output/BDATA.unprot.bin", CODE%, P%, LOAD%

binaries/README.md renamed to 1-source-files/images/README.md

@@ -29,19 +29,19 @@
 \
 \ ******************************************************************************
 
-INCLUDE "sources/elite-header.h.asm"
+INCLUDE "1-source-files/main-sources/elite-header.h.asm"
 
 _SNG47                  = (_RELEASE = 1)
 _COMPACT                = (_RELEASE = 2)
 
 IF _SNG47
- PUTFILE "output/M128Elt.bin", "M128Elt", &FF0E00, &FF0E43
- PUTFILE "output/BDATA.bin", "BDATA", &000000, &000000
- PUTFILE "output/BCODE.bin", "BCODE", &000000, &000000
+ PUTFILE "3-assembled-output/M128Elt.bin", "M128Elt", &FF0E00, &FF0E43
+ PUTFILE "3-assembled-output/BDATA.bin", "BDATA", &000000, &000000
+ PUTFILE "3-assembled-output/BCODE.bin", "BCODE", &000000, &000000
 ELIF _COMPACT
- PUTFILE "output/M128Elt.bin", "!BOOT", &000E00, &000E43
- PUTFILE "output/BDATA.bin", "BDATA", &001300, &001300
- PUTFILE "output/BCODE.bin", "ELITE", &001300, &002C6C
+ PUTFILE "3-assembled-output/M128Elt.bin", "!BOOT", &000E00, &000E43
+ PUTFILE "3-assembled-output/BDATA.bin", "BDATA", &001300, &001300
+ PUTFILE "3-assembled-output/BCODE.bin", "ELITE", &001300, &002C6C
 ENDIF
 
-PUTFILE "output/README.txt", "README", &FFFFFF, &FFFFFF
+PUTFILE "3-assembled-output/README.txt", "README", &FFFFFF, &FFFFFF

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

@@ -21,11 +21,11 @@
 \
 \ This source file produces the following binary file:
 \
-\   * output/M128Elt.bin
+\   * M128Elt.bin
 \
 \ ******************************************************************************
 
-INCLUDE "sources/elite-header.h.asm"
+INCLUDE "1-source-files/main-sources/elite-header.h.asm"
 
 CPU 1                   \ Switch to 65SC12 assembly, as this code runs on the
                         \ BBC Master
@@ -1220,10 +1220,10 @@ ENDIF
 
 \ ******************************************************************************
 \
-\ Save output/M128Elt.bin
+\ Save M128Elt.bin
 \
 \ ******************************************************************************
 
 PRINT "S.M128Elt ", ~CODE%, " ", ~P%, " ", ~LOAD%, " ", ~LOAD%
-SAVE "output/M128Elt.bin", CODE%, P%, LOAD%
+SAVE "3-assembled-output/M128Elt.bin", CODE%, P%, LOAD%
 

sources/elite-data.asm renamed to 1-source-files/main-sources/elite-data.asm

@@ -21,11 +21,11 @@
 \
 \ This source file produces the following binary file:
 \
-\   * output/README.txt
+\   * README.txt
 \
 \ ******************************************************************************
 
-INCLUDE "sources/elite-header.h.asm"
+INCLUDE "1-source-files/main-sources/elite-header.h.asm"
 
 _SNG47                  = (_RELEASE = 1)
 _COMPACT                = (_RELEASE = 2)
@@ -57,5 +57,5 @@ ENDIF
  EQUS "---------------------------------------"
  EQUB 10, 13
 
-SAVE "output/README.txt", readme, P%
+SAVE "3-assembled-output/README.txt", readme, P%