Refresh Documentation

ReadMe.md

@@ -3,7 +3,7 @@
 ## Z80/Z180 System Software
 
 Version 3.1 Pre-release  
-21 Mar 2022
+09 Jul 2022
 
 Wayne Warthen <wwarthen@gmail.com>
 
@@ -418,7 +418,7 @@ therefore, globally available.
 
 Some custom applications do not fit on the ROM disk. They are found on
 the disk image files or the individual files can be found in the
-Binary\\Apps directory of the distribution.
+Binary\Apps directory of the distribution.
 
 | Application | Description                                                 |
 |-------------|-------------------------------------------------------------|
@@ -924,7 +924,7 @@ documents.
 Note that the build scripts for RomWBW create the default disk images
 supplied with RomWBW. It is relatively easy to customize the contents of
 the disk images that are part of RomWBW. This is described in more
-detail in the Source\\Images directory of the distribution.
+detail in the Source\Images directory of the distribution.
 
 ## FAT Filesystem Transfers
 
@@ -945,7 +945,7 @@ however. Longer filenames will show up as a truncated version.
 
 The `FAT` application is not on your ROM disk because it is too large to
 fit. You will find it on all of the pre-built disk images as well as in
-the Binary\\Apps directory of the distribution.
+the Binary\Apps directory of the distribution.
 
 For advanced users, it is possible to create a hybrid disk that contains
 CP/M slices at the beginning and a FAT filesystem after. Such a hybrid
@@ -953,7 +953,7 @@ disk can be used to boot an operating system and still have access to
 FAT files on the FAT portion of the disk. David Reese has prepared a
 document describing how to do this. It is called
 “SC126_How-To_No_2\_Preparing_an_SD_Card_for_Use_with_SC126_Rev_1-5.pdf”
-and can be found in the Doc\\Contrib directory of the distribution.
+and can be found in the Doc\Contrib directory of the distribution.
 
 # Startup Command Processing
 
@@ -1164,7 +1164,7 @@ system on your disk.
     CP/M 3 uses a multi-step boot process involving multiple files. The
     CP/M 3 boot files are not included on the ROM disk due to space
     constraints. You will need to transfer the files to your system from
-    the RomWBW distribution directory Binary\\CPM3.
+    the RomWBW distribution directory Binary\CPM3.
 
     After this is done, you will need to use `SYSCOPY` to place the CP/M
     3 loader image on the boot tracks of all CP/M 3 boot disks/slices.
@@ -1182,7 +1182,7 @@ system on your disk.
     ZPM3 uses a multi-step boot process involving multiple files. The
     ZPM3 boot files are not included on the ROM disk due to space
     constraints. You will need to transfer the files to your system from
-    the RomWBW distribution directory Binary\\ZPM3.
+    the RomWBW distribution directory Binary\ZPM3.
 
     After this is done, you will need to use `SYSCOPY` to place the ZPM3
     loader image on the boot tracks of all ZPM3 boot disks/slices. The
@@ -1225,8 +1225,7 @@ For example: `B>COPY ASSIGN.COM C:`
 Some RomWBW custom applications are too large to fit on the ROM disk. If
 you are using any of these you will need to transfer them to your system
 and then update all copies. These applications are found in the
-Binary\\Apps directory of the distribution and in all of the disk
-images.
+Binary\Apps directory of the distribution and in all of the disk images.
 
 -   FAT.COM
 -   TUNE.COM

ReadMe.txt

@@ -1,6 +1,6 @@
 RomWBW Getting Started
 Wayne Warthen (mailto:wwarthen@gmail.com)
-21 Mar 2022
+09 Jul 2022
 
 
 
@@ -17,7 +17,7 @@ RomWBW
 Z80/Z180 System Software
 
 Version 3.1 Pre-release
-21 Mar 2022
+09 Jul 2022
 
 Wayne Warthen wwarthen@gmail.com
 
@@ -213,15 +213,23 @@ disk devices.
 
 The following ROM applications are available at the boot loader prompt:
 
-  Application    
-  -------------- --------------------------------------------------------
-  Monitor        Z80 system debug monitor w/ Intel Hex loader
-  Forth          Brad Rodriguez’s ANSI compatible Forth language
-  Basic          Nascom 8K BASIC language
-  Tasty BASIC    Dimitri Theuling’s Tiny BASIC implementation
-  Play           A simple video game (requires ANSI terminal emulation)
-  Network Boot   Boot through Wiznet MT011 device
-  Flash Update   Upload and flash a new ROMWBW image using xmodem
+  --------------------------------------------------------------------------
+  Application   
+  ------------- ------------------------------------------------------------
+  Monitor       Z80 system debug monitor w/ Intel Hex loader
+
+  Forth         Brad Rodriguez’s ANSI compatible Forth language
+
+  Basic         Nascom 8K BASIC language
+
+  Tasty BASIC   Dimitri Theuling’s Tiny BASIC implementation
+
+  Play          A simple video game (requires ANSI terminal emulation)
+
+  Network Boot  Boot through Wiznet MT011 device
+
+  Flash Update  Upload and flash a new ROMWBW image using xmodem
+  --------------------------------------------------------------------------
 
 In general, the command to exit these applications and restart the
 system is BYE. The exceptions are the Monitor which uses B and Play
@@ -467,11 +475,15 @@ Some custom applications do not fit on the ROM disk. They are found on
 the disk image files or the individual files can be found in the
 Binary\Apps directory of the distribution.
 
+  --------------------------------------------------------------------------
   Application   Description
-  ------------- -------------------------------------------------------------
+  ------------- ------------------------------------------------------------
   TUNE          Play .PT2, .PT3, .MYM audio files.
+
   FAT           Access MS-DOS FAT filesystems from RomWBW (based on FatFs).
+
   INTTEST       Test interrupt vector hooking.
+  --------------------------------------------------------------------------
 
 Additional documentation on all of these applications can be found in
 “RomWBW Applications.pdf” in the Doc directory of the distribution.
@@ -667,14 +679,21 @@ The following table shows the disk image files available. Note that the
 images in the “Hard” column are fine for use on CF Cards, SD Cards, as
 well as real spinning hard disks.
 
-  Floppy         Hard           Description
-  -------------- -------------- ------------------------------
-  fd_cpm22.img   hd_cpm22.img   DRI CP/M 2.2 boot disk
-  fd_zsdos.img   hd_zsdos.img   ZSDOS 1.1 boot disk
-  fd_nzcom.img   hd_nzcom.img   NZCOM boot disk
-  fd_cpm3.img    hd_cpm3.img    DRI CP/M 3 boot disk
-  fd_zpm3.img    hd_zpm3.img    ZPM3 boot disk
-  fd_ws4.img     hd_ws4.img     WordStar v4 application disk
+  -----------------------------------------------------------------------
+  Floppy          Hard            Description
+  --------------- --------------- ---------------------------------------
+  fd_cpm22.img    hd_cpm22.img    DRI CP/M 2.2 boot disk
+
+  fd_zsdos.img    hd_zsdos.img    ZSDOS 1.1 boot disk
+
+  fd_nzcom.img    hd_nzcom.img    NZCOM boot disk
+
+  fd_cpm3.img     hd_cpm3.img     DRI CP/M 3 boot disk
+
+  fd_zpm3.img     hd_zpm3.img     ZPM3 boot disk
+
+  fd_ws4.img      hd_ws4.img      WordStar v4 application disk
+  -----------------------------------------------------------------------
 
 In addition to the disk images above, there is also a special hard disk
 image called hd_combo.img. This image contains all of the images above,
@@ -685,14 +704,21 @@ system options.
 
 This is the layout of the hd_combo disk image:
 
-  Slice     Description
-  --------- ------------------------------
-  Slice 0   DRI CP/M 2.2 boot disk
-  Slice 1   ZSDOS 1.1 boot disk
-  Slice 2   NZCOM boot disk
-  Slice 3   DRI CP/M 3 boot disk
-  Slice 4   ZPM3 boot disk
-  Slice 5   WordStar v4 application disk
+  ------------------------------------------------------------------------
+  Slice   Description
+  ------- ----------------------------------------------------------------
+  Slice 0 DRI CP/M 2.2 boot disk
+
+  Slice 1 ZSDOS 1.1 boot disk
+
+  Slice 2 NZCOM boot disk
+
+  Slice 3 DRI CP/M 3 boot disk
+
+  Slice 4 ZPM3 boot disk
+
+  Slice 5 WordStar v4 application disk
+  ------------------------------------------------------------------------
 
 Note that unlike the ROM firmware, you do not need to choose a disk
 image specific to your hardware. Because the RomWBW firmware provides a

Readme.unix

@@ -34,13 +34,11 @@ By default, this will generate all of the standard configurations of
 RomWBW for all platforms.  If you just want to build the ROM for a
 specific platform and configuration you can use
 
-	make ROM_PLATFORM=<platform> ROM_CONFIG=<config> [ROMSIZE=<size>]
+	make ROM_PLATFORM=<platform> ROM_CONFIG=<config>
 
 where <platform> is one of the supported platforms such as SBC, RCZ80, 
-etc. and <config> is a configuration of that platform.  A ROM size may
-optionally be specified and must be one of 128, 256, 512, or 1024.  It
-defaults to 512.  For example, to build the "126" configuration of
-the "SCZ180" platform:
+etc. and <config> is a configuration of that platform.  For example,
+to build the "126" configuration of the "SCZ180" platform:
 
 	make ROM_PLATFORM=SCZ180 ROM_CONFIG=126
 
@@ -77,7 +75,7 @@ running.  To disable this feature:
 DISCLAIMER: You do this at your own risk.  I highly recommend that you
 return the settings back to normal immediately after doing a build.
 
-Heavy use is made of make's include facility and pattern rules. the 
+Heavy use is made of make's include facility and pattern rules. The 
 master rule set is in Tools/Makefile.inc.  Changes here will affect 
 almost every Makefile, and where exceptions are needed, the overrides 
 are applied in the lower Makefiles.
@@ -101,10 +99,10 @@ Credit:
 	hacked to do case-insensitivity. These are not marked, and are 
 	not extensive.
 
-	zx is from the distributed version, and also has local hacks 
+	zxcc is from the distributed version, and also has local hacks 
 	for case insensitivity.
 
-	Both zx and cpmtools ship with an overly complicated makefile 
+	Both zxcc and cpmtools ship with an overly complicated makefile 
 	generation system and this is ignored.
 
 	This whole Linux build framework is the work of Curt Mayer,