MirrorRepos/RomWBW
1
0
Fork 1
mirror of https://github.com/wwarthen/RomWBW.git synced 2026-02-06 14:11:48 -06:00
Code Issues Projects Releases Wiki Activity

Merge pull request #240 from wwarthen/dev

Browse Source 
Dev
This commit is contained in:
b1ackmai1er
2021-10-22 19:13:06 +08:00
committed by GitHub
parent 84edfeee28 149f84f64a
commit df26984135
24 changed files with 188 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Source/BuildDoc.cmd Normal file
View File

@@ -0,0 +1,4 @@
@echo off
setlocal
pushd Doc && call Build || exit /b & popd

2
Source/Clean.cmd
View File

@@ -17,3 +17,5 @@ pushd HBIOS && call Clean.cmd & popd
pushd Images && call Clean & popd
pushd Prop && call Clean & popd
pushd RomDsk && call Clean & popd
pushd Doc && call Clean & popd

24
Source/Doc/Applications.md
View File

@@ -1,10 +1,14 @@
!include(Common.inc)
!def(document)(Applications)
\include{"Common.h"}
\define{doc_title}{Applications}
---
title: !product !document
author: !author (mailto:!authmail)
date: !date
institution: !orgname
title: |
| \doc_product \doc_title
|
| Version \doc_ver
author: \doc_author (mailto:\doc_authmail)
date: \doc_date
institution: \doc_orgname
documentclass: article
toc: true
toc-depth: 1
@@ -57,8 +61,8 @@ on the media.
Most of the applications are included as source code in the RomWBW
distribution and are built in the normal build process. The source
code is found in the Source\\Apps directory of the distribution. The
binary executable applications are found in the Binary\\Apps directory.
code is found in the Source\\\\Apps directory of the distribution. The
binary executable applications are found in the Binary\\\\Apps directory.
The following table clarifies where each of the applications can be
found:
@@ -552,7 +556,7 @@ manually perform a verification function with the `FLASH VERIFY` form
of the command.
The author's documentation for the application is found in the RomWBW
distribution in the Doc\\Contrib directory.
distribution in the Doc\\\\Contrib directory.
## Notes
@@ -981,6 +985,6 @@ The `TUNE` application was custom written for RomWBW. All of the
hardware interface code is specific to RomWBW. The sound file decoding
software was adapted and embedded from pre-existing sources. The YM
player code is from MYMPLAY 0.4 by Lieves!Tuore and the PT player code
is (c)2004-2007 S.V.Bulba <vorobey@mail.khstu.ru>.
is (c)2004-2007 S.V.Bulba <vorobey@@mail.khstu.ru>.
The source code is provided in the RomWBW distribution.

27
Source/Doc/Architecture.md
View File

@@ -1,13 +1,14 @@
!include(Common.inc)
!def(document)(Architecture)
\include{"Common.h"}
\define{doc_title}{Architecture}
---
title: |
| !product
| \doc_product \doc_title
|
| !document
author: !author (mailto:!authmail)
date: !date
institution: !orgname
| Version \doc_ver
author: \doc_author (mailto:\doc_authmail)
date: \doc_date
institution: \doc_orgname
documentclass: book
classoption:
- oneside
@@ -44,14 +45,14 @@ header-includes:
\includegraphics[width=\paperwidth]{Graphics/Logo.pdf} \par
\vfill
\raggedleft
{\scshape \bfseries \fontsize{48pt}{56pt} \selectfont !product \par}
{\bfseries \fontsize{32pt}{36pt} \selectfont !document \par}
{\scshape \bfseries \fontsize{48pt}{56pt} \selectfont \doc_product \par}
{\bfseries \fontsize{32pt}{36pt} \selectfont \doc_title \par}
\vspace{24pt}
{\huge Version !ver \\ !date \par}
{\huge Version \doc_ver \\ \doc_date \par}
\vspace{24pt}
{\large \itshape !orgname \\ \href{http://!orgurl}{!orgurl} \par}
{\large \itshape \doc_orgname \\ \href{http://\doc_orgurl}{\doc_orgurl} \par}
\vspace{12pt}
{\large \itshape !author \\ \href{mailto:authmail}{!authmail} \par}
{\large \itshape \doc_author \\ \href{mailto:\doc_authmail}{\doc_authmail} \par}
\end{titlepage}
}
\pagestyle{empty}
@@ -70,7 +71,7 @@ include-before:
```{=latex}
\clearpage
\pagenumbering{arabic}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill !product !document}}}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill \doc_product \doc_title}}}
```
Overview

48
Source/Doc/Build.cmd Normal file
View File

@@ -0,0 +1,48 @@
@echo off
setlocal
::
:: NOTE: Pandoc and Latex (MiKTeX or TexLive) must be installed
:: and available on commandline for this build to work!!!
::
set TOOLS=..\..\Tools
set PATH=%TOOLS%\m4;%TOOLS%\gpp;%PATH%
if not "%1"=="" (call :GenDoc %1 & goto :eof)
call :GenDoc GettingStarted
:: call :GenDoc UserGuide
call :GenDoc Applications
:: call :GenDoc Errata
:: call :GenDoc ZSystem
call :GenDoc Architecture
call :GenDoc Catalog
call :GenDoc ROM_Applications
if exist GettingStarted.pdf copy GettingStarted.pdf "..\..\Doc\RomWBW Getting Started.pdf" || exit /b
if exist GettingStarted.gfm copy GettingStarted.gfm ..\..\ReadMe.md || exit /b
if exist GettingStarted.txt copy GettingStarted.txt ..\..\ReadMe.txt || exit /b
if exist Applications.pdf copy Applications.pdf "..\..\Doc\RomWBW Applications.pdf" || exit /b
if exist Architecture.pdf copy Architecture.pdf "..\..\Doc\RomWBW Architecture.pdf" || exit /b
if exist Catalog.pdf copy Catalog.pdf "..\..\Doc\RomWBW Disk Catalog.pdf" || exit /b
if exist ROM_Applications.pdf copy ROM_Applications.pdf "..\..\Doc\ROM Applications.pdf" || exit /b
echo.
goto :eof
:GenDoc
echo.
echo Processing document %1.md...
gpp -T <%1.md >%1.tmp
pandoc %1.tmp -f markdown -t pdf -s -o %1.pdf --default-image-extension=pdf || exit /b
pandoc %1.tmp -f markdown -t html -o %1.html --default-image-extension=png || exit /b
pandoc %1.tmp -f markdown -t dokuwiki -o %1.dw --default-image-extension=png || exit /b
pandoc %1.tmp -f markdown -t gfm -o %1.gfm --default-image-extension=png || exit /b
pandoc %1.tmp -f markdown -t plain -o %1.txt --default-image-extension=png || exit /b
goto :eof

20
Source/Doc/Catalog.md
View File

@@ -1,15 +1,15 @@
!include(Common.inc)
!def(document)(Disk Catalog)
!def(author)(Mykl Orders)
\include{"Common.h"}
\define{doc_title}{Disk Catalog}
\define{doc_author}{Mykl Orders}
---
title: |
| !product
| Version !ver
| \doc_product \doc_title
|
| !document
author: !author (mailto:!authmail)
date: !date
institution: !orgname
| Version \doc_ver
author: \doc_author
date: \doc_date
institution: \doc_orgname
documentclass: article
classoption:
- oneside
@@ -40,7 +40,7 @@ header-includes:
\pagestyle{fancyplain}
\fancyhf{}
\pagenumbering{arabic}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill !product !document}}}
\lhead{\fancyplain{}{\nouppercase{\footnotesize \bfseries \leftmark \hfill \doc_product \doc_title}}}
\lfoot{\small RetroBrew Computing Group ~~ {\xrfill[3pt]{1pt}[cyan]} ~~ \thepage}
```

10
Source/Doc/Clean.cmd Normal file
View File

@@ -0,0 +1,10 @@
@echo off
setlocal
if exist *.gfm del *.gfm
if exist *.txt del *.txt
if exist *.dw del *.dw
if exist *.html del *.html
if exist *.tex del *.tex
if exist *.pdf del *.pdf
if exist *.tmp del *.tmp

8
Source/Doc/Common.h Normal file
View File

@@ -0,0 +1,8 @@
\define{doc_ver}{3.1 Pre-release}
\define{doc_product}{RomWBW}
\define{doc_title}{Document Title}
\define{doc_author}{Wayne Warthen}
\define{doc_date}{\date{%d %b %Y}}
\define{doc_authmail}{wwarthen@@gmail.com}
\define{doc_orgname}{RetroBrew Computers Group}
\define{doc_orgurl}{www.retrobrewcomputers.org}

7
Source/Doc/Common.inc
View File

@@ -1,7 +0,0 @@
!def(ver)(3.1 Pre-release)
!def(date)(!mdate)
!def(product)(RomWBW)
!def(author)(Wayne Warthen)
!def(authmail)(wwarthen@gmail.com)
!def(orgname)(RetroBrew Computers Group)
!def(orgurl)(www.retrobrewcomputers.org)

9
Source/Doc/Common.m4 Normal file
View File

@@ -0,0 +1,9 @@
changequote(`{{', `}}')
define({{doc_ver}},{{3.1 Pre-release}})
define({{doc_product}},{{RomWBW}})
define({{doc_title}},{{Document Title}})
define({{doc_author}},{{Wayne Warthen}})
define({{doc_authmail}},{{wwarthen@gmail.com}})
define({{doc_orgname}},{{RetroBrew Computers Group}})
define({{doc_orgurl}},{{www.retrobrewcomputers.org}})

25
Source/Doc/GettingStarted.md
View File

@@ -1,13 +1,14 @@
!include(Common.inc)
!def(document)(Getting Started)
\include{"Common.h"}
\define{doc_title}{Getting Started}
---
title: |
| !product
| \doc_product \doc_title
|
| !document
author: !author (mailto:!authmail)
date: !date
institution: !orgname
| Version \doc_ver
author: \doc_author (mailto:\doc_authmail)
date: \doc_date
institution: \doc_orgname
documentclass: article
classoption:
- oneside
@@ -37,10 +38,10 @@ header-includes:
## Z80/Z180 System Software
| Version !ver
| !date
| Version \doc_ver
| \doc_date
!author() [!authmail](mailto:!authmail)
\doc_author [\doc_authmail](mailto:\doc_authmail)
### Download
@@ -1141,7 +1142,7 @@ To cancel: Ctrl-X, pause, Ctrl-X
Thanks for the upload
E>flash write rom.rom
FLASH4 by Will Sowerbutts <will@sowerbutts.com> version 1.2.3
FLASH4 by Will Sowerbutts <will@@sowerbutts.com> version 1.2.3
Using RomWBW (v2.6+) bank switching.
Flash memory chip ID is 0xBFB7: 39F040
@@ -1383,4 +1384,4 @@ RetroBrew Computers projects is via the community forums:
Submission of issues and bugs are welcome at the
[RomWBW GitHub Repository](https://github.com/wwarthen/RomWBW).
Also feel free to email !author at [!authmail](mailto:!authmail).
Also feel free to email \doc_author at [\doc_authmail](mailto:\doc_authmail).

40
Source/Doc/Makefile Normal file
View File

@@ -0,0 +1,40 @@
#
# NOTE: Pandoc, Latex (MiKTeX or TexLive), and gpp must be installed
# and available on commandline for this build to work!!!
# Typically "sudo apt install pandoc, texlive-latex-extra, gpp"
#
OBJECTS = GettingStarted.pdf GettingStarted.gfm GettingStarted.txt Applications.pdf Architecture.pdf Catalog.pdf ROM_Applications.pdf
# DEST = ../../Doc
TOOLS = ../../Tools
OTHERS = *.tmp
include $(TOOLS)/Makefile.inc
all :: deploy
%.tmp : %.md
gpp -T $< >$@
%.pdf : %.tmp
pandoc $< -f markdown -t latex -s -o $@ --default-image-extension=pdf
%.html : %.tmp
pandoc $< -f markdown -t html -s -o $@ --default-image-extension=pdf
%.dw : %.tmp
pandoc $< -f markdown -t dokuwiki -s -o $@ --default-image-extension=pdf
%.gfm : %.tmp
pandoc $< -f markdown -t gfm -s -o $@ --default-image-extension=pdf
%.txt : %.tmp
pandoc $< -f markdown -t plain -s -o $@ --default-image-extension=pdf
deploy :
cp GettingStarted.pdf "../../Doc/RomWBW Getting Started.pdf"
cp GettingStarted.gfm "../../ReadMe.md"
cp GettingStarted.txt "../../ReadMe.txt"
cp Applications.pdf "../../Doc/RomWBW Applications.pdf"
cp Architecture.pdf "../../Doc/RomWBW Architecture.pdf"
cp Catalog.pdf "../../Doc/RomWBW Disk Catalog.pdf"
cp ROM_Applications.pdf "../../Doc/ROM Applications.pdf"

19
Source/Doc/ROM_Applications.md
View File

@@ -1,12 +1,15 @@
\include{"Common.h"}
\define{doc_title}{ROM Applications}
\define{doc_title}{Phillip Summers}
!include(Common.inc)
!def(document)(ROM Applications)
!def(author)(Phillip Summers)
---
title: !product !document
author: !author (mailto:!authmail)
date: !date
institution: !orgname
title: |
| \doc_product \doc_title
|
| Version \doc_ver
author: \doc_author
date: \doc_date
institution: \doc_orgname
documentclass: article
toc: true
toc-depth: 1
@@ -127,7 +130,7 @@ Examples: `D 100 1FF`
0130: E5 CD 6C 1F C1 C1 E5 2A C9 8C E5 CD 45 05 E5 CD åÍl.ÁÁå*É.åÍE.åÍ
0140: 59 1F C3 00 00 C3 AE 01 C3 51 04 C3 4C 02 C3 57 Y.Ã..î.ÃQ.ÃL.ÃW
0150: 02 C3 64 02 C3 75 02 C3 88 02 C3 B2 03 C3 0D 04 .Ãd.Ãu.Ã..ò.Ã..
0160: C3 19 04 C3 22 04 C3 2A 04 C3 35 04 C3 40 04 C3 Ã..Ã".Ã*.Ã5.Ã@.Ã
0160: C3 19 04 C3 22 04 C3 2A 04 C3 35 04 C3 40 04 C3 Ã..Ã".Ã*.Ã5.Ã@@.Ã
0170: 48 04 C3 50 04 C3 50 04 C3 50 04 C3 8F 02 C3 93 H.ÃP.ÃP.ÃP.Ã..Ã.
0180: 02 C3 94 02 C3 95 02 C3 85 04 C3 C7 04 C3 D1 01 .Ã..Ã..Ã..ÃÇ.ÃÑ.
0190: C3 48 02 C3 E7 04 C3 56 03 C3 D0 01 C3 D0 01 C3 ÃH.Ãç.ÃV.ÃÐ.ÃÐ.Ã

1
Source/Makefile
View File

@@ -14,5 +14,6 @@ SUBDIRS += HBIOS
SUBDIRS += Images
SUBDIRS += ZRC
SUBDIRS += ZZR
#SUBDIRS += Doc
TOOLS = ../Tools
include $(TOOLS)/Makefile.inc

2
Source/ver.inc
View File

@@ -2,4 +2,4 @@
#DEFINE RMN 1
#DEFINE RUP 1
#DEFINE RTP 0
#DEFINE BIOSVER "3.1.1-pre.128"
#DEFINE BIOSVER "3.1.1-pre.130"

2
Source/ver.lib
View File

@@ -3,5 +3,5 @@ rmn equ 1
rup equ 1
rtp equ 0
biosver macro
db "3.1.1-pre.128"
db "3.1.1-pre.130"
endm