Add INSTALL to all distribution packages, add note in README.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1937
This commit is contained in:
Simon Howard 2010-05-30 03:03:44 +00:00
parent f00575079e
commit 373a8dd0c1
2 changed files with 33 additions and 27 deletions

55
README
View file

@ -13,33 +13,37 @@ Chocolate Doom aims to:
* As far as possible, provide all the same features that are available
using the DOS version.
== Setting up gameplay ==
For instructions on how to set up Chocolate Doom for play, see the
INSTALL file.
== Configuration File ==
Chocolate Doom is compatible with the DOS Doom configuration file
(normally named 'default.cfg'). Existing configuration files for
DOS Doom should therefore simply work out of the box. However,
Chocolate Doom also provides some extra settings. These are stored
in a separate file named 'chocolate-doom.cfg'.
(normally named 'default.cfg'). Existing configuration files for DOS
Doom should therefore simply work out of the box. However, Chocolate
Doom also provides some extra settings. These are stored in a
separate file named 'chocolate-doom.cfg'.
The configuration can be edited using the chocolate-setup tool.
== Command-line options ==
For a complete list of command-line options, see the CMDLINE
file.
For a complete list of command-line options, see the CMDLINE file.
== Playing TCs ==
With Vanilla Doom there is no way to include sprites in PWAD files.
Chocolate Doom's '-file' command line option behaves exactly the
same as Vanilla Doom, and trying to play TCs by adding the WAD files
using '-file' will not work.
With Vanilla Doom there is no way to include sprites in PWAD files.
Chocolate Doom's '-file' command line option behaves exactly the same
as Vanilla Doom, and trying to play TCs by adding the WAD files using
'-file' will not work.
Many Total Conversions (TCs) are distributed as a PWAD file which must
be merged into the main IWAD. Typically a copy of DEUSF.EXE is
included which performs this merge. Chocolate Doom includes a new
option, '-merge', which will simulate this merge. Essentially, the
WAD directory is merged in memory, removing the need to modify the
option, '-merge', which will simulate this merge. Essentially, the
WAD directory is merged in memory, removing the need to modify the
IWAD on disk.
To play TCs using Chocolate Doom, run like this:
@ -53,26 +57,27 @@ Here are some examples:
== Other information ==
* More information, including information about how to play various classic
TCs, is available on the Chocolate Doom website:
* More information, including information about how to play various
classic TCs, is available on the Chocolate Doom website:
http://www.chocolate-doom.org/
You are encouraged to sign up and contribute any useful information you may
have regarding the port!
You are encouraged to sign up and contribute any useful information
you may have regarding the port!
* Chocolate Doom is not perfect. See the BUGS file for a list of known
issues. New bug reports can be submitted to the Chocolate Doom bug
tracker on Sourceforge. See:
* Chocolate Doom is not perfect. See the BUGS file for a list of
known issues. New bug reports can be submitted to the Chocolate
Doom bug tracker on Sourceforge. See:
http://sourceforge.net/projects/chocolate-doom
* Source code patches are welcome, but please follow the style guidelines -
see the file named HACKING included with the source distribution.
* Source code patches are welcome, but please follow the style
guidelines - see the file named HACKING included with the source
distribution.
* Chocolate Doom is distributed under the GNU GPL. See the COPYING file
for more information.
* Chocolate Doom is distributed under the GNU GPL. See the COPYING
file for more information.
* Please send any feedback, questions or suggestions to fraggle@gmail.com.
Thanks!
* Please send any feedback, questions or suggestions to
fraggle@gmail.com. Thanks!

View file

@ -49,10 +49,11 @@ rm -rf $RPM_BUILD_ROOT
%files
%doc %{_mandir}/man5/*
%doc %{_mandir}/man6/*
%doc NEWS
%doc AUTHORS
%doc README
%doc README.OPL
%doc INSTALL
%doc NEWS
%doc AUTHORS
%doc COPYING
%doc CMDLINE
%doc BUGS