Browse files

Add README

Add new README and rename existing file README.OLD.

Signed-off-by: Paul Brook <paul@codesourcery.com>
  • Loading branch information...
1 parent 179349f commit 6d9341822add34dcf83d35fc34641501b38171d4 Paul Brook committed May 25, 2010
Showing with 64 additions and 32 deletions.
  1. +32 −32 README
  2. +32 −0 README.old
View
64 README
@@ -1,32 +1,32 @@
-Wolfenstein 3D for Linux - http://www.icculus.org/wolf3d/
-------------------------
-
-This is an in-progress port of the id Software MS-DOS game, Wolfenstein 3D,
-to the GNU/Linux operating system.
-
-Save game and configuration file formats are not yet "solid" (files created
-with an older version may not work with a new binary), but they probably
-won't have to change.
-
-NOTE: This requires SDL 1.2 (http://www.libsdl.org)
-
-NOTE: edit version.h to change the gametype.
-
-How to use:
-
-About:
-
-Thanks:
-* id Software
-* David Haslam
-* Ryan Gordon
-* Bill Heineman
-* Dan Olson
-* Leonardo Zide
-* Tatsuyuki Satoh
-* Chuck Mason
-* And everyone who has emailed me about this code! Thanks!
-
---
-Steven Fuller
-relnev@icculus.org
+Wolfenstein 3D (embedded)
+-------------------------
+
+This is a port of Wolfenstein 3D to the Stellaryis LM3S6965EVB
+microcontroller development board.
+
+A Linux/SDL binary can be build by setting
+ PROGS=sdlwolf3d
+at the start of the Makefile.
+
+A fair amount hacking was involved, including removal of "optional" features
+(Menus, Demos, etc), conversion to 4-bit greyscale, lossy compression of
+wall textures, integration of graphics into the application binary, and
+a single use/fire button.
+
+Only the shareware version has been tested.
+
+To build you will need to original game data, specifically:
+ gamemaps.wl1
+ maphead.wl1
+ vgadict.wl1
+ vgagraph.wl1
+ vgahead.wl1
+ vswap.wl1
+These files are still subject to the original licence, so the resulting
+binary may not be redistributable.
+
+In theory removing the EMBEDDED define form version.h may restore the
+original game, but I wouldn't bet on it.
+
+Paul Brook
+paul@codesourcery.com
View
32 README.old
@@ -0,0 +1,32 @@
+Wolfenstein 3D for Linux - http://www.icculus.org/wolf3d/
+------------------------
+
+This is an in-progress port of the id Software MS-DOS game, Wolfenstein 3D,
+to the GNU/Linux operating system.
+
+Save game and configuration file formats are not yet "solid" (files created
+with an older version may not work with a new binary), but they probably
+won't have to change.
+
+NOTE: This requires SDL 1.2 (http://www.libsdl.org)
+
+NOTE: edit version.h to change the gametype.
+
+How to use:
+
+About:
+
+Thanks:
+* id Software
+* David Haslam
+* Ryan Gordon
+* Bill Heineman
+* Dan Olson
+* Leonardo Zide
+* Tatsuyuki Satoh
+* Chuck Mason
+* And everyone who has emailed me about this code! Thanks!
+
+--
+Steven Fuller
+relnev@icculus.org

0 comments on commit 6d93418

Please sign in to comment.