Add an index page to the new documentation.

This commit is contained in:
Yamagi Burmeister 2018-11-07 15:50:41 +01:00
parent 22ade5dc7f
commit be7d532b06

23
doc/01_index.md Normal file
View file

@ -0,0 +1,23 @@
# Yamagi Quake II Documentation
Welcome to the Yamagi Quake II documentation. Here is documented how
Yamagi Quake II is installed and configured. Please make sure to read
through the whole guide before asking questions!
Some general hints:
* No matter what's the current keyboard layout or on which platform the
game is running, the console is always opened and closed by pressing
**Left-Shift + Escape**.
* Yamagi Quake II saves it's configuration, savegames and screenshots
to *~/.yq2* (unixoid platforms) or *My Documents\YamagiQ2* (Windows).
If Yamagi Quake II is started with the `-portable` switch all data
is saved in the same directory as the executables.
The documentation is split into several documents:
* [Index File](01_index.md)
* [Installation Guide](02_installation.md)
* [Configuration Guide](03_configuration.md)
* [List Of All New Console Variables](04_cvarlist.md)
* [Packaging Guide For Maintainers](05_packaging.md)