Use Introduction for ReadMe

See Discussion Documentation 3.5 Improvement #493
wwarthen · Jan 24, 2025 · 7d1cbe0 · 7d1cbe0
1 parent 8e189b4
commit 7d1cbe0
Show file tree

Hide file tree

Showing 10 changed files with 865 additions and 604 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/Build.cmd b/Source/Doc/Build.cmd
@@ -15,16 +15,18 @@ set PATH=%TOOLS%\gpp;%PATH%
 
 if not "%1"=="" (call :GenDoc %1 & goto :eof)
 
-call :GenDoc ReadMe || exit /b
+:: call :GenDoc ReadMe || exit /b
 call :GenDoc Introduction || exit /b
 call :GenDoc UserGuide || exit /b
 call :GenDoc SystemGuide || exit /b
 call :GenDoc Applications || exit /b
 call :GenDoc Catalog || exit /b
 call :GenDoc Hardware || exit /b
 
-if exist ReadMe.gfm copy Readme.gfm ..\..\ReadMe.md || exit /b
-if exist ReadMe.txt copy ReadMe.txt ..\..\ReadMe.txt || exit /b
+:: if exist ReadMe.gfm copy Readme.gfm ..\..\ReadMe.md || exit /b
+:: if exist ReadMe.txt copy ReadMe.txt ..\..\ReadMe.txt || exit /b
+if exist Introduction.gfm copy Introduction.gfm ..\..\ReadMe.md || exit /b
+if exist Introduction.txt copy Introduction.txt ..\..\ReadMe.txt || exit /b
 if exist Introduction.pdf copy Introduction.pdf "..\..\Doc\RomWBW Introduction.pdf" || exit /b
 if exist UserGuide.pdf copy UserGuide.pdf "..\..\Doc\RomWBW User Guide.pdf" || exit /b
 if exist SystemGuide.pdf copy SystemGuide.pdf "..\..\Doc\RomWBW System Guide.pdf" || exit /b

diff --git a/Source/Doc/Makefile b/Source/Doc/Makefile
@@ -9,7 +9,7 @@
 # On Ubuntu Linux:
 # apt install gpp pandoc texlive texlive-luatex texlive-fonts-extra
 #
-OBJECTS = ReadMe.gfm ReadMe.txt Introduction.pdf UserGuide.pdf SystemGuide.pdf Applications.pdf Catalog.pdf Hardware.pdf
+OBJECTS = Introduction.gfm Introduction.txt Introduction.pdf UserGuide.pdf SystemGuide.pdf Applications.pdf Catalog.pdf Hardware.pdf
 # DEST = ../../Doc
 TOOLS = ../../Tools
 OTHERS = *.tmp
@@ -37,8 +37,8 @@ all :: deploy
 	pandoc $< -f markdown -t plain -s -o $@ --default-image-extension=pdf
 
 deploy :
-	cp ReadMe.gfm            "../../ReadMe.md"
-	cp ReadMe.txt            "../../ReadMe.txt"
+	cp Introduction.gfm      "../../ReadMe.md"
+	cp Introduction.txt      "../../ReadMe.txt"
 	cp Introduction.pdf      "../../Doc/RomWBW Introduction.pdf"
 	cp UserGuide.pdf         "../../Doc/RomWBW User Guide.pdf"
 	cp SystemGuide.pdf       "../../Doc/RomWBW System Guide.pdf"