shithub: choc

Info  •  Files  •  Log  •  Branches

Update README to reflect the fact that Chocolate Doom now includes
multiple games.

Subversion-branch: /branches/v2-branch
Subversion-revision: 2649

--- a/README

+++ b/README

@@ -1,18 +1,21 @@

-Chocolate Doom is a Doom source port which aims to behave as closely

-as possible to the original DOS Doom executables.

+Chocolate Doom aims to accurately reproduce the original DOS version of

+Doom and other games based on the Doom engine in a form that can be

+run on modern computers.

-Chocolate Doom aims to:

+Originally, Chocolate Doom was only a Doom source port. The project

+now includes ports of Heretic and Hexen, and Strife.

- * Be compatible with DOS Doom demos

- * Be compatible with DOS Doom configuration files

- * Be compatible with DOS Doom savegames

- * Be compatible with DOS Doom bugs

- * Provide the same "feel" as DOS Doom (display and input should behave

-   the same)

- * As far as possible, provide all the same features that are available

-   using the DOS version.

+Chocolate Doom's aims are:

+ * To always be 100% Free and Open Source software.

+ * Portability to as many different operating systems as possible.

+ * Accurate reproduction of the original DOS versions of the games,

+   including bugs.

+ * Compatibility with the DOS demo, configuration and savegame files.

+ * To provide an accurate retro "feel" (display and input should

+   behave the same).

+

 == Setting up gameplay ==

 For instructions on how to set up Chocolate Doom for play, see the

@@ -66,9 +69,9 @@

    you may have regarding the port!

  * Chocolate Doom is not perfect.  Although it aims to accurately

-   emulate Vanilla Doom, some of the behavior of Vanilla Doom can be

-   very difficult to reproduce. Because of the nature of the project,

-   you may also encounter Vanilla Doom bugs; these are intentionally

+   emulate reproduce the DOS executables, some behavior can be very

+   difficult to reproduce. Because of the nature of the project, you

+   may also encounter Vanilla Doom bugs; these are intentionally

    present; see the NOT-BUGS file for more information.

    New bug reports can be submitted to the Chocolate Doom bug tracker