archive/dolphin
1
0
Fork 0
mirror of https://github.com/dolphin-emu/dolphin.git synced 2024-09-20 03:11:51 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: Add a LaTeX equivalent of the GameCube DSP User's Manual

Browse source 
The existing manual is nice to read and get up to speed on things,
however it has one major problem. It's actually a pain to extend or
modify, despite being released under the GNU documentation license: It's
in PDF format.

I've taken the time to reproduce what the document more-or-less looks
like in order to allow extending the document using open-source tools
while also using a more general solution like LaTeX, which can generate
the document into multiple formats if desirable.

This should make extending the document much easier (and not lock the
information into one concrete format).
This commit is contained in:
Lioncash 2018-04-09 23:53:10 -04:00
parent 9d7009796c
commit db2c6df675
No known key found for this signature in database
GPG key ID: 4E3C3CC1031BA9C7
3 changed files with 3745 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/DSP/GC_DSP.pdf
View file

Binary file not shown.

3737
docs/DSP/GameCube_DSP_Users_Manual/GameCube_DSP_Users_Manual.tex Normal file
View file

File diff suppressed because it is too large Load diff

8
docs/DSP/GameCube_DSP_Users_Manual/README.md Normal file
View file

@ -0,0 +1,8 @@
# Building the GameCube DSP User's Manual
1. Install a LaTeX environment and implementation (for example, MiKTeX).
2. Once installed, install any of the packages within `GameCube_DSP_Users_Manual.tex` that aren't installed
by default in the environment via the implementation's package manager.
- These are searchable at the top of the TeX file via the `\usepackage` statements.
3. Once all relevant packages are installed, run `pdflatex` (or any other output processor for LaTeX files) using `GameCube_DSP_Users_Manual.tex` as the input. Run the processor over the TeX file twice -- once to generate the main textual content, and the other time to build and integrate any indexes (such as the table of contents).
4. If all goes well, it should build fine with no errors.