From af937c41f8a4bd14aed1883feb6a6e9f9c0fa8af Mon Sep 17 00:00:00 2001 From: Mark Moxon Date: Mon, 20 Nov 2023 15:06:00 +0000 Subject: [PATCH] Added READMEs to all folders --- 1-source-files/basic-programs/README.md | 13 +++++++++++++ 1-source-files/boot-files/README.md | 9 +++++++++ 1-source-files/images/README.md | 9 +++++++++ 1-source-files/main-sources/README.md | 15 +++++++++++++++ 3-assembled-output/README.md | 2 ++ 4-reference-binaries/README.md | 2 ++ 6 files changed, 50 insertions(+) create mode 100644 1-source-files/basic-programs/README.md create mode 100644 1-source-files/boot-files/README.md create mode 100644 1-source-files/images/README.md create mode 100644 1-source-files/main-sources/README.md diff --git a/1-source-files/basic-programs/README.md b/1-source-files/basic-programs/README.md new file mode 100644 index 0000000..e71c6e3 --- /dev/null +++ b/1-source-files/basic-programs/README.md @@ -0,0 +1,13 @@ +# BASIC programs for the BBC Micro disc version of Aviator + +This folder contains the BASIC programs from the BBC Micro disc version of Aviator. + +* [$.AVIA.bin]($.AVIA.bin) shows the game's instructions and then runs $.AVIATOR + +* [$.AVIA1.bin]($.AVIA1.bin) shows the game's key controls and then loads the game in $.AVIA? + +* [$.AVIATOR.bin]($.AVIATOR.bin) shows the Acornsoft mode 7 loader screen and then runs $.AVIA1 + +--- + +_Mark Moxon_ \ No newline at end of file diff --git a/1-source-files/boot-files/README.md b/1-source-files/boot-files/README.md new file mode 100644 index 0000000..9124758 --- /dev/null +++ b/1-source-files/boot-files/README.md @@ -0,0 +1,9 @@ +# Boot files for the BBC Micro disc version of Aviator + +This folder contains the boot file from the BBC Micro disc version of Aviator. + +* [$.!BOOT.bin]($.!BOOT.bin) is the boot file from the game disc, which runs $.AVIA + +--- + +_Mark Moxon_ \ No newline at end of file diff --git a/1-source-files/images/README.md b/1-source-files/images/README.md new file mode 100644 index 0000000..d7a86e4 --- /dev/null +++ b/1-source-files/images/README.md @@ -0,0 +1,9 @@ +# Image binaries for the BBC Micro disc version of Aviator + +This folder contains the image binaries from the BBC Micro disc version of Aviator. + +* [$.DASHBD.bin]($.DASHBD.bin) is the dashboard image + +--- + +_Mark Moxon_ \ No newline at end of file diff --git a/1-source-files/main-sources/README.md b/1-source-files/main-sources/README.md new file mode 100644 index 0000000..f6ad66f --- /dev/null +++ b/1-source-files/main-sources/README.md @@ -0,0 +1,15 @@ +# Annotated source code for the BBC Micro disc version of Aviator + +This folder contains the annotated source code for the BBC Micro disc version of Aviator. + +* Main source files: + + * [aviator-source.asm](aviator-source.asm) contains the main source for the game + +* Other source files: + + * [aviator-disc.asm](aviator-disc.asm) builds the SSD disc image from the assembled binaries and other source files + +--- + +_Mark Moxon_ \ No newline at end of file diff --git a/3-assembled-output/README.md b/3-assembled-output/README.md index 11612c3..33d55d7 100644 --- a/3-assembled-output/README.md +++ b/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 Aviator. +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_ \ No newline at end of file diff --git a/4-reference-binaries/README.md b/4-reference-binaries/README.md index b5a545d..bb7a972 100644 --- a/4-reference-binaries/README.md +++ b/4-reference-binaries/README.md @@ -2,6 +2,8 @@ This folder contains the binaries from the game disc for the BBC Micro disc version of Aviator, as well as reference binaries for the other releases. +* [bbcmicro-co-uk](bbcmicro-co-uk) contains the binaries from the Complete BBC Micro Games Archive at bbcmicro.co.uk + --- _Mark Moxon_ \ No newline at end of file