Minor Doc and Build Tweaks

dinoboards · Oct 6, 2023 · d98547d · d98547d
1 parent a157d9b
commit d98547d
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 30 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 Errata.pdf b/Doc/RomWBW Errata.pdf
diff --git a/Doc/RomWBW ROM Applications.pdf b/Doc/RomWBW ROM Applications.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/Makefile b/Makefile
@@ -1,5 +1,11 @@
-all:
+.PHONY: tools source clean clobber diff dist
+
+all: tools source
+
+tools:
 	$(MAKE) --directory Tools
+
+source:
 	$(MAKE) --directory Source
 
 clean:

diff --git a/ReadMe.md b/ReadMe.md
@@ -1,9 +1,9 @@
 
 
 **RomWBW ReadMe** \
-Version 3.3 \
+Version 3.4 \
 Wayne Warthen  ([wwarthen@gmail.com](mailto:wwarthen@gmail.com)) \
-05 Oct 2023
+06 Oct 2023
 
 # Overview
 

diff --git a/ReadMe.txt b/ReadMe.txt
@@ -1,6 +1,6 @@
 RomWBW ReadMe
 Wayne Warthen (wwarthen@gmail.com)
-05 Oct 2023
+06 Oct 2023
 
 
 

diff --git a/Source/Doc/Basic.h b/Source/Doc/Basic.h
@@ -1,4 +1,4 @@
-$define{doc_ver}{Version 3.3}$
+$define{doc_ver}{Version 3.4}$
 $define{doc_product}{RomWBW}$
 $define{doc_root}{https://github.com/wwarthen/RomWBW/raw/dev/Doc}$
 $ifndef{doc_title}$ $define{doc_title}{Document Title}$ $endif$

diff --git a/Source/Doc/Makefile b/Source/Doc/Makefile
@@ -1,7 +1,7 @@
 #
-# NOTE: Pandoc, Latex (MiKTeX or TexLive), and gpp must be installed
+# NOTE: gpp, Pandoc, and Latex (MiKTeX or TexLive) must be installed
 # and available on commandline for this build to work!!!
-# Typically "sudo apt install pandoc, texlive-latex-extra, gpp"
+# Typically "sudo apt install gpp pandoc texlive-latex-extra texlive-luatex texlive-fonts-extra fonts-roboto"
 #
 OBJECTS = ReadMe.gfm ReadMe.txt UserGuide.pdf SystemGuide.pdf Applications.pdf ROM_Applications.pdf Catalog.pdf Errata.pdf
 # DEST = ../../Doc
@@ -16,7 +16,7 @@ all :: deploy
 	gpp -o $@ -U "$$" "$$" "{" "}{" "}$$" "{" "}" "@@@" "" -M "$$" "$$" "{" "}{" "}$$" "{" "}" $<
 
 %.pdf : %.tmp
-	pandoc $< -f markdown -t latex -s -o $@ --default-image-extension=pdf
+	pandoc $< -f markdown -t pdf -s -o $@ --default-image-extension=pdf --pdf-engine=lualatex
 
 %.html : %.tmp
 	pandoc $< -f markdown -t html -s -o $@ --default-image-extension=pdf

diff --git a/Source/Doc/UserGuide.md b/Source/Doc/UserGuide.md
@@ -206,7 +206,7 @@ below, **carefully** pick the appropriate ROM image for your hardware.
 | [Z80-Retro SBC]^8^                                             | -       | Z80RETRO_std.rom   | 38400         |
 | [S100 Computers Z180]^9^                                       | S100    | S100_std.rom       | 38400         |
 | [Duodyne Z80 System]^1^                                        | Duo     | DUO_std.rom        | 38400         |
-| [Heath H8 Z80 System]                                          | H8      | HEATH_std.rom      | 115200        |
+| [Heath H8 Z80 System]^10^                                      | H8      | HEATH_std.rom      | 115200        |
 
 | ^1^Designed by Andrew Lynch
 | ^2^Designed by Sergey Kiselev
@@ -217,6 +217,7 @@ below, **carefully** pick the appropriate ROM image for your hardware.
 | ^7^Designed by Bill Shen
 | ^8^Designed by Peter Wilson
 | ^9^Designed by John Monahan
+| ^10^Designed by Les Bird
 
 RCBus refers to Spencer Owen's RC2014 bus specification and derivatives
 including RC26, RC40, RC80, and BP80.

diff --git a/Source/Makefile b/Source/Makefile
@@ -24,27 +24,57 @@ ifeq ($(UNAME), Linux)
 # uname machine strings for building Propeller
 endif
 
-SUBDIRS = HDIAG
+.PHONY: doc prop shared bp images rom zrc zzrc
 
+all: prop shared images rom zrc zzrc
+
+doc:
+	$(MAKE) --directory Doc $(ACTION)
+
+prop:
 ifeq ($(BUILDPROP), 1)
-SUBDIRS += Prop
+	$(MAKE) --directory Prop $(ACTION)
 else
-$(info "Builing Propeller is not supported on this $(ARCH) host Linux OS")
+	$(info Builing Propeller is not supported on this $(ARCH) host Linux OS)
 endif
 
-SUBDIRS += Apps
-SUBDIRS += CBIOS
-SUBDIRS += Forth
-SUBDIRS += TastyBasic
-SUBDIRS += Fonts
-SUBDIRS += CPM22 ZCPR ZCPR-DJ ZSDOS CPM3 ZPM3 QPM
-#SUBDIRS += BPBIOS
-SUBDIRS += pSys
-SUBDIRS += RomDsk
-SUBDIRS += HBIOS
-SUBDIRS += Images
-SUBDIRS += ZRC
-SUBDIRS += ZZRC
-#SUBDIRS += Doc
-TOOLS = ../Tools
-include $(TOOLS)/Makefile.inc
+shared:
+	$(MAKE) --directory HDIAG $(ACTION)
+	$(MAKE) --directory CBIOS $(ACTION)
+	$(MAKE) --directory CPM22 $(ACTION)
+	$(MAKE) --directory QPM $(ACTION)
+	$(MAKE) --directory ZCPR $(ACTION)
+	$(MAKE) --directory ZCPR-DJ $(ACTION)
+	$(MAKE) --directory ZSDOS $(ACTION)
+	$(MAKE) --directory CPM3 $(ACTION)
+	$(MAKE) --directory ZPM3 $(ACTION)
+	$(MAKE) --directory pSys $(ACTION)
+	$(MAKE) --directory Apps $(ACTION)
+	$(MAKE) --directory Forth $(ACTION)
+	$(MAKE) --directory TastyBasic $(ACTION)
+	$(MAKE) --directory Fonts $(ACTION)
+	$(MAKE) --directory RomDsk $(ACTION)
+
+bp:
+	$(MAKE) --directory BPBIOS $(ACTION)
+
+images:
+	$(MAKE) --directory Images $(ACTION)
+
+rom:
+	$(MAKE) --directory HBIOS $(ACTION)
+
+zrc:
+	$(MAKE) --directory ZRC $(ACTION)
+
+zzrc:
+	$(MAKE) --directory ZZRC $(ACTION)
+
+
+clean: ACTION=clean
+
+clean: all
+
+diff: ACTION=diff
+
+diff: all
diff --git a/Source/ReadMeDoc.txt b/Source/ReadMeDoc.txt
@@ -0,0 +1,33 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This document describes the process to build the custom documentation
+for RomWBW.  The RomWBW documentation is not normally built as part of
+the full build process.  This is because it requires external tools
+to be installed.
+
+All source documents are first pre-processed with gpp to allow use of
+some global variable expansions.  Pandoc is then used to generate a
+variety of output formats.  The most significant of these are the PDF
+documents.  Pandoc invokes a Latex-type processor (LuaTeX) to
+produce the final PDF documents.
+
+Required for Windows:
+ - Pandoc (https://pandoc.org/)
+ - MiKTeX (https://miktex.org/)
+   - Install Roboto font from MiKTeX Console
+
+Required for Linux:
+ - gpp ((apt install gpp)
+ - Pandoc (dpkg -i pandoc-3.1.8-1-amd64.deb)
+ - TexLive (apt install texlive-latex-extra texlive-luatex fonts-roboto texlive-fonts-extra)
+
+The source directory for the documentation is .../Source/Doc. From this 
+directory run Build.cmd for Windows or make for Linux to create the 
+output documents.  This will create the final documents and copy them 
+to their destination directories.
diff --git a/Source/ver.inc b/Source/ver.inc
@@ -2,7 +2,7 @@
 #DEFINE	RMN	4
 #DEFINE	RUP	0
 #DEFINE	RTP	0
-#DEFINE BIOSVER	"3.4.0-dev.0"
+#DEFINE BIOSVER	"3.4.0-dev.1"
 #define rmj	RMJ
 #define rmn	RMN
 #define rup	RUP

diff --git a/Source/ver.lib b/Source/ver.lib
@@ -3,5 +3,5 @@ rmn	equ	4
 rup	equ	0
 rtp	equ	0
 biosver	macro
-	db	"3.4.0-dev.0"
+	db	"3.4.0-dev.1"
 	endm