WinUAE Help Readme
==================

0. License
1. Introduction
2. Building
3. Errors
4. Contact


0. License
----------
All of the content of this help is released under the terms of the GNU
Free Documentation License (FDL). For a copy of the license, refer to the
Credits section.


1. Introduction
---------------
Welcome to the official help file for WinUAE! It has been designed to aid
you in using WinUAE, and is integrated into the main WinUAE program.
This will give you information on how to get started with WinUAE, a
description of all the GUI Settings, information about the emulation itself,
and some additonal information about real Amigas in the Background
Information section.
Experienced users can find valuable tips for better speed and functionality
of WinUAE at the Hints For Power Users page.


2. Building
-----------
The help is written in Markdown (docs/) and built with MkDocs Material.
Page structure and navigation are defined in mkdocs.yml.

    pip install -r requirements.txt
    mkdocs serve      (live preview at http://127.0.0.1:8000)
    mkdocs build      (static site in site/, PDF in site/winuaehelp.pdf)


3. Errors
---------
Content of the help file is carefully edited by people with years of
experience with Amigas and WinUAE. We try to provide useful and clean
information. If you find mistakes or typos in the help file, you are
encouraged to let one of the authors know.


4. Contact
----------
Contact:  Georg Veichtlbauer
E-Mail:   georg@vware.at
Web:      https://www.vware.at

Contact:  Peter Hutchison
E-Mail:   pjhutch17@talktalk.net
Web:      https://www.pjhutchison.org