piwalker/dolphin
1
0
Fork 0
mirror of https://github.com/dolphin-emu/dolphin.git synced 2024-11-15 05:47:56 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity
244918acb8
dolphin/docs/DSP/GameCube_DSP_Users_Manual/README.md
Lioncash db2c6df675
docs: Add a LaTeX equivalent of the GameCube DSP User's Manual 
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).
2018-04-13 19:03:08 -04:00

778 B
Raw Blame History

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.