mirror of
https://github.com/yquake2/yquake2remaster.git
synced 2024-11-10 07:12:07 +00:00
Add an index page to the new documentation.
This commit is contained in:
parent
22ade5dc7f
commit
be7d532b06
1 changed files with 23 additions and 0 deletions
23
doc/01_index.md
Normal file
23
doc/01_index.md
Normal 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)
|
Loading…
Reference in a new issue