diff --git a/Source/Doc/Build.cmd b/Source/Doc/Build.cmd index 24c649d5..3736b6b5 100644 --- a/Source/Doc/Build.cmd +++ b/Source/Doc/Build.cmd @@ -2,8 +2,12 @@ setlocal :: -:: NOTE: Pandoc and Latex (MiKTeX or TexLive) must be installed -:: and available on commandline for this build to work!!! +:: NOTE: Pandoc, LuaLatex (MiKTeX or TexLive), and Roboto Font +:: must be installed and available on commandline for this build to work!!! +:: +:: - Pandoc (https://pandoc.org/) +:: - MiKTeX (https://miktex.org/) +:: - Install Roboto font from MiKTeX Console :: set TOOLS=..\..\Tools @@ -35,9 +39,6 @@ echo. echo Processing document %1... -::gpp -o %1.tmp %1.md -::gpp -o %1.tmp -U "\\" "" "{" "}{" "}" "{" "}" "#" "" %1.md -::gpp -o %1.tmp -U "" "" "(" "," ")" "(" ")" "#" "" -M "#" "\n" " " " " "\n" "(" ")" %1.md gpp -o %1.tmp -U "$" "$" "{" "}{" "}$" "{" "}" "@@@" "" -M "$" "$" "{" "}{" "}$" "{" "}" %1.md || exit /b ::pandoc %1.tmp -f markdown -t latex -s -o %1.tex --default-image-extension=pdf || exit /b diff --git a/Source/Doc/Makefile b/Source/Doc/Makefile index 6baf0527..04c8df4a 100644 --- a/Source/Doc/Makefile +++ b/Source/Doc/Makefile @@ -1,11 +1,14 @@ # -# NOTE: gpp, Pandoc, and Latex (MiKTeX or TexLive) must be installed +# NOTE: gpp, Pandoc, LuaLatex (MiKTeX or TexLive), and Roboto Font must be installed # and available on commandline for this build to work!!! -# Typically "sudo apt install gpp pandoc texlive-latex-extra texlive-luatex texlive-fonts-extra fonts-roboto" -# On Macintosh +# +# On MacOS: # brew install gpp pandoc texlive # brew install --cask font-roboto # +# On Ubuntu Linux: +# apt install gpp pandoc texlive texlive-luatex texlive-fonts-extra +# OBJECTS = ReadMe.gfm ReadMe.txt UserGuide.pdf SystemGuide.pdf Applications.pdf Catalog.pdf Errata.pdf # DEST = ../../Doc TOOLS = ../../Tools @@ -40,4 +43,4 @@ deploy : cp SystemGuide.pdf "../../Doc/RomWBW System Guide.pdf" cp Applications.pdf "../../Doc/RomWBW Applications.pdf" cp Catalog.pdf "../../Doc/RomWBW Disk Catalog.pdf" - cp Errata.pdf "../../Doc/RomWBW Errata.pdf" + cp Errata.pdf "../../Doc/RomWBW Errata.pdf" diff --git a/Source/ReadMeDoc.txt b/Source/ReadMeDoc.txt index 0ca671e4..9e8ed406 100644 --- a/Source/ReadMeDoc.txt +++ b/Source/ReadMeDoc.txt @@ -22,12 +22,18 @@ Required for Windows: - 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) +Required for Ubuntu Linux: + - gpp (apt install gpp) + - Pandoc (apt install pandoc) + - TexLive (apt install texlive texlive-luatex 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. \ No newline at end of file +Required for MacOS: + - gpp (brew install gpp) + - pandoc (brew install pandoc) + - TexLive (brew install texlive) + - Roboto Font (brew install --cask font-roboto) + +The source directory for the documentation is /Source/Doc. From this +directory run "Build.cmd" on Windows or "make" on Linux/Mac to create +the output documents. This will create the final documents and copy +them to their destination directories. \ No newline at end of file