documentation update

git-svn-id: svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@1037 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
Ozkan Sezer 2014-09-20 14:00:25 +00:00
parent 5d10347f78
commit b7857441ab
3 changed files with 17 additions and 8 deletions

View file

@ -4,7 +4,7 @@
<toc> <toc>
<verb></verb> <verb></verb>
<em>Page last edited Sep. 15, 2014</em> <em>Page last edited Sep. 20, 2014</em>
<sect> About <p> <sect> About <p>
@ -69,11 +69,12 @@ cp quakespasm /usr/local/games/quake (for example)
<newline> <newline>
Compile time options include Compile time options include
<itemize> <itemize>
<item><bf>make DO_USERDIRS=1</bf> to include user directories support
<item><bf>make DEBUG=1</bf> for debugging <item><bf>make DEBUG=1</bf> for debugging
<item><bf>make SDL_CONFIG=</bf><em>/PATH/TO/SDL-CONFIG</em> for unusual SDL installations <item><bf>make SDL_CONFIG=</bf><em>/PATH/TO/SDL-CONFIG</em> for unusual SDL installations
<item><bf>make USE_SDL2=1</bf> to compile against SDL2 instead of SDL1.2
</itemize> </itemize>
<p>Streaming music playback requires "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG files. <p>Streaming music playback requires "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG files.
<p>HOME directory support can be enabled via <bf>Misc/homedir_0.patch</bf>
<p>The project can also be built with Codeblocks (project files included).</p> <p>The project can also be built with Codeblocks (project files included).</p>
<sect1> Windows <p> <sect1> Windows <p>
@ -108,6 +109,7 @@ OS X has a well known gamma issue where the screen turns dark, but we currently
<sect1> Changes in 0.90.0<p> <sect1> Changes in 0.90.0<p>
<itemize> <itemize>
<item> Unix/Mac user directories support. Disabled by default, 'make DO_USERDIRS=1' to enable it. <item> Unix/Mac user directories support. Disabled by default, 'make DO_USERDIRS=1' to enable it.
<item> SDL2 support. Disabled by default, 'make USE_SDL2=1' to enable it.
<item> Revised/improved the 'game' command, i.e. on-the-fly mod changing. It now accepts an optional second argument for mission packs or quoth support i.e. -hipnotic, -rogue, or -quoth. For example, for WarpSpasm: "game warp -quoth" <item> Revised/improved the 'game' command, i.e. on-the-fly mod changing. It now accepts an optional second argument for mission packs or quoth support i.e. -hipnotic, -rogue, or -quoth. For example, for WarpSpasm: "game warp -quoth"
<item> Command line: "-game {quoth/hipnotic/rogue}" is now treated the same as -quoth, -hipnotic, or -rogue. <item> Command line: "-game {quoth/hipnotic/rogue}" is now treated the same as -quoth, -hipnotic, or -rogue.
<item> Console speed now resolution-independent. <item> Console speed now resolution-independent.

View file

@ -7,11 +7,12 @@
<BODY> <BODY>
<H1>QuakeSpasm</H1> <H1>QuakeSpasm</H1>
<H2></H2><P> <H2></H2>
<P>
<PRE> <PRE>
</PRE> </PRE>
</P> </P>
<P><EM>Page last edited Sep. 15, 2014</EM></P> <P><EM>Page last edited Sep. 20, 2014</EM></P>
<P> <P>
<H2><A NAME="toc1">1.</A> <A HREF="Quakespasm.html#s1">About </A></H2> <H2><A NAME="toc1">1.</A> <A HREF="Quakespasm.html#s1">About </A></H2>
@ -144,12 +145,13 @@ cp quakespasm /usr/local/games/quake (for example)
<BR> <BR>
Compile time options include Compile time options include
<UL> <UL>
<LI><B>make DO_USERDIRS=1</B> to include user directories support</LI>
<LI><B>make DEBUG=1</B> for debugging</LI> <LI><B>make DEBUG=1</B> for debugging</LI>
<LI><B>make SDL_CONFIG=</B><EM>/PATH/TO/SDL-CONFIG</EM> for unusual SDL installations</LI> <LI><B>make SDL_CONFIG=</B><EM>/PATH/TO/SDL-CONFIG</EM> for unusual SDL installations</LI>
<LI><B>make USE_SDL2=1</B> to compile against SDL2 instead of SDL1.2</LI>
</UL> </UL>
</P> </P>
<P>Streaming music playback requires "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG files.</P> <P>Streaming music playback requires "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG files.</P>
<P>HOME directory support can be enabled via <B>Misc/homedir_0.patch</B></P>
<P>The project can also be built with Codeblocks (project files included).</P> <P>The project can also be built with Codeblocks (project files included).</P>
<H2><A NAME="ss4.2">4.2</A> <A HREF="#toc4.2">Windows </A> <H2><A NAME="ss4.2">4.2</A> <A HREF="#toc4.2">Windows </A>
</H2> </H2>
@ -186,6 +188,7 @@ these patched libSDL binaries may help.
<P> <P>
<UL> <UL>
<LI> Unix/Mac user directories support. Disabled by default, 'make DO_USERDIRS=1' to enable it.</LI> <LI> Unix/Mac user directories support. Disabled by default, 'make DO_USERDIRS=1' to enable it.</LI>
<LI> SDL2 support. Disabled by default, 'make USE_SDL2=1' to enable it.</LI>
<LI> Revised/improved the 'game' command, i.e. on-the-fly mod changing. It now accepts an optional second argument for mission packs or quoth support i.e. -hipnotic, -rogue, or -quoth. For example, for WarpSpasm: "game warp -quoth"</LI> <LI> Revised/improved the 'game' command, i.e. on-the-fly mod changing. It now accepts an optional second argument for mission packs or quoth support i.e. -hipnotic, -rogue, or -quoth. For example, for WarpSpasm: "game warp -quoth"</LI>
<LI> Command line: "-game {quoth/hipnotic/rogue}" is now treated the same as -quoth, -hipnotic, or -rogue.</LI> <LI> Command line: "-game {quoth/hipnotic/rogue}" is now treated the same as -quoth, -hipnotic, or -rogue.</LI>
<LI> Console speed now resolution-independent.</LI> <LI> Console speed now resolution-independent.</LI>

View file

@ -35,7 +35,7 @@
______________________________________________________________________ ______________________________________________________________________
Page last edited Sep. 15, 2014 Page last edited Sep. 20, 2014
1. About 1. About
@ -125,15 +125,17 @@
Compile time options include Compile time options include
o make DO_USERDIRS=1 to include user directories support
o make DEBUG=1 for debugging o make DEBUG=1 for debugging
o make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installations o make SDL_CONFIG=/PATH/TO/SDL-CONFIG for unusual SDL installations
o make USE_SDL2=1 to compile against SDL2 instead of SDL1.2
Streaming music playback requires "libmad" or "libmpg123" for MP3, and Streaming music playback requires "libmad" or "libmpg123" for MP3, and
"libogg" and "libvorbis" for OGG files. "libogg" and "libvorbis" for OGG files.
HOME directory support can be enabled via Misc/homedir_0.patch
The project can also be built with Codeblocks (project files The project can also be built with Codeblocks (project files
included). included).
@ -178,6 +180,8 @@
o Unix/Mac user directories support. Disabled by default, o Unix/Mac user directories support. Disabled by default,
'make DO_USERDIRS=1' to enable it. 'make DO_USERDIRS=1' to enable it.
o SDL2 support. Disabled by default, 'make USE_SDL2=1' to enable it.
o Revised/improved the 'game' command, i.e. on-the-fly mod changing. o Revised/improved the 'game' command, i.e. on-the-fly mod changing.
It now accepts an optional second argument for mission packs or It now accepts an optional second argument for mission packs or
quoth support i.e. -hipnotic, -rogue, or -quoth. For example, for quoth support i.e. -hipnotic, -rogue, or -quoth. For example, for