Merge pull request #495 from kiwisincebirth/map/doc2

Some very minor tweaks to documentation
wwarthen · Jan 24, 2025 · 8e189b4 · 8e189b4
2 parents 1ae6274 + c1866d7
commit 8e189b4
Show file tree

Hide file tree

Showing 12 changed files with 645 additions and 643 deletions.
diff --git a/Doc/RomWBW Applications.pdf b/Doc/RomWBW Applications.pdf
diff --git a/Doc/RomWBW Disk Catalog.pdf b/Doc/RomWBW Disk Catalog.pdf
diff --git a/Doc/RomWBW Hardware.pdf b/Doc/RomWBW Hardware.pdf
diff --git a/Doc/RomWBW Introduction.pdf b/Doc/RomWBW Introduction.pdf
diff --git a/Doc/RomWBW System Guide.pdf b/Doc/RomWBW System Guide.pdf
diff --git a/Doc/RomWBW User Guide.pdf b/Doc/RomWBW User Guide.pdf
diff --git a/ReadMe.md b/ReadMe.md
diff --git a/ReadMe.txt b/ReadMe.txt
diff --git a/Source/Doc/Catalog.md b/Source/Doc/Catalog.md
@@ -671,6 +671,8 @@ The following are found in
 | CPN3MT.LBR      | CP/NET 3            | CP/M 3          | RCBus w/ MT011          |
 | CPN12DUO.LBR    | CP/NET 1.2          | CP/M 2.2        | Duodyne w/ Disk I/O     |
 | CPN3DUO.LBR     | CP/NET 3            | CP/M 3          | Duodyne w/ Disk I/O     |
+| CPN12SER.LBR    | CP/NET 1.2          | CP/M 2.2        | RomWBW Serial Port      |
+| CPN3SER.LBR     | CP/NET 3            | CP/M 3          | RomWBW Serial Port      |
 
 ## General Purpose Applications
 

diff --git a/Source/Doc/Introduction.md b/Source/Doc/Introduction.md
@@ -25,31 +25,6 @@ $doc_hardware$ .
 
 `\clearpage`{=latex}
 
-## Conventions Used
-
-#### Size Suffixes
-
-Within the documentation and in RomWBW in general, the use of size
-suffixes KB, MB, GB, and TB refer to the binary variant as shown
-below.  The modern suffixes (KiB, MiB, etc.) are not used here because
-they were not prevalent during the time that the RomWBW OSes were
-used.  This keeps all of RomWBW and associated applications consistent.
-
-| Suffix     | Value     | Meaning                                |
-|------------|-----------|----------------------------------------|
-| KB         | 1024      | 1,024 bytes                            |
-| MB         | 1024^2^   | 1,048,576 bytes                        |
-| GB         | 1024^3^   | 1,073,741,824 bytes                    |
-| TB         | 1024^4^   | 1,099,511,627,776 bytes                |
-
-#### Links and URLs
-
-Many of the references in the documentation to Internet addresses (URLs)
-do not provide the address in the text.  However, these links are
-embedded and "clickable" within the documents.  Your PDF viewer should
-highlight these links in some manner (typically an alternate color
-or an underline).
-
 # Description
 
 ## Primary Features
@@ -69,6 +44,7 @@ Supported hardware features of RomWBW include:
 * Video drivers including TMS9918, SY6545, MOS8563, HD6445
 * Keyboard (PS/2) drivers via VT8242 or PPI interfaces
 * Real time clock drivers including DS1302, BQ4845
+* Support for CP/NET networking using Wiznet, MT011 or Serial
 * Built-in VT-100 terminal emulation support
 
 A dynamic disk drive letter assignment mechanism allows mapping
@@ -77,7 +53,7 @@ Additionally, mass storage devices (IDE Disk, CF Card, SD Card, etc.)
 support the use of multiple slices (up to 256 per device). Each slice
 contains a complete CP/M filesystem and can be mapped independently to
 any drive letter. This overcomes the inherent size limitations in legacy
-OSes and allows up to 2GB of accessible storage on a single device, 
+OSes and allows up to 2GB of addressable storage on a single device, 
 with up to 128MB accessible at any one time.
 
 ## Included Software
@@ -89,15 +65,15 @@ slices, each with a full operating system implementation. If you use
 this disk image, you can easily pick whichever operating system you
 want to boot without changing media.
 
-Some of the included software
+Some of the included software:
 
 * Operating Systems (CP/M 2.2, ZSDOS, NZ-COM, CP/M 3, ZPM3, Z3PLUS, QPM )
-* Additional operating systems, p-System, FreeRTOS, and FUZIX.
+* Support for other operating systems, p-System, FreeRTOS, and FUZIX.
 * Programming Tools (Z80ASM, Turbo Pascal, Forth, Cowgol)
-* C Compilers including Aztec, and HI-TECK
+* C Compiler's including Aztec-C, and HI-TECH C
 * Microsoft Basic Compiler, and Microsoft Fortran
 * Some games such as Colossal Cave, Zork, etc
-* Wordstar
+* Wordstar Word processing software
 
 Some of the provided software can be launched directly from the
 ROM firmware itself:
@@ -165,6 +141,19 @@ included -- no need to install assemblers, etc.  The firmware can also
 be built using Linux or MacOS after confirming a few standard tools
 have been installed.
 
+## Installation & Operation
+
+In general, installation of RomWBW on your platform is very simple. You
+just need to program your ROM with the correct ROM image from the RomWBW
+distribution. Subsequently, you can write disk images on your disk
+drives (IDE disk, CF Card, SD Card, etc.) which then provides even more
+functionality.
+
+Complete instructions for installation and operation of RomWBW are found
+in the $doc_user$. It is also a good idea to review the [Release
+Notes](https://github.com/wwarthen/RomWBW/blob/master/RELEASE_NOTES.md)
+for helpful release-specific information.
+
 ## Documentation
 
 There are several documents that form the core of the RomWBW documentation:

diff --git a/Source/Doc/ReadMe.md b/Source/Doc/ReadMe.md
@@ -32,6 +32,7 @@ Supported hardware features of RomWBW include:
 * Video drivers including TMS9918, SY6545, MOS8563, HD6445
 * Keyboard (PS/2) drivers via VT8242 or PPI interfaces
 * Real time clock drivers including DS1302, BQ4845
+* Support for CP/NET networking using Wiznet, MT011 or Serial
 * Built-in VT-100 terminal emulation support
 
 RomWBW is distributed as both source code and pre-built ROM and disk

diff --git a/Source/Doc/UserGuide.md b/Source/Doc/UserGuide.md
@@ -13,6 +13,31 @@ find this document far too basic.  Others will find it lacking in many
 areas.  I am doing my best and encourage you to provide constructive
 feedback.
 
+#### Conventions Used
+
+##### Size Suffixes
+
+Within the documentation and in RomWBW in general, the use of size
+suffixes KB, MB, GB, and TB refer to the binary variant as shown
+below.  The modern suffixes (KiB, MiB, etc.) are not used here because
+they were not prevalent during the time that the RomWBW OSes were
+used.  This keeps all of RomWBW and associated applications consistent.
+
+| Suffix     | Value     | Meaning                                |
+|------------|-----------|----------------------------------------|
+| KB         | 1024      | 1,024 bytes                            |
+| MB         | 1024^2^   | 1,048,576 bytes                        |
+| GB         | 1024^3^   | 1,073,741,824 bytes                    |
+| TB         | 1024^4^   | 1,099,511,627,776 bytes                |
+
+##### Links and URLs
+
+Many of the references in the documentation to Internet addresses (URLs)
+do not provide the address in the text.  However, these links are
+embedded and "clickable" within the documents.  Your PDF viewer should
+highlight these links in some manner (typically an alternate color
+or an underline).
+
 # Getting Started
 
 ## Installation