replaced readme, actually did it this time.

1 files changed, 79 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..0914023
--- /dev/null
+++ b/README
@@ -0,0 +1,79 @@
+A brief readme added by Wyatt Ward.
+
+I added this readme and some updated Makefiles, as well as tweaking a few of
+
+Quake's source files, to make it work properly on a modern Linux system.
+
+
+The original, unmodified source can be found here:
+https://github.com/id-Software/Quake
+
+
+A good how-to for arguments and troubleshooting and such is here:
+http://www.linuxdoc.org/HOWTO/Quake-HOWTO-1.html
+
+The how-to did not mention a few problems, which I created fixes for. These
+
+include the mouse not working to allow input and no input whatsoever (not even
+
+the keyboard) working in fullscreen. I also fixed a buffer overflow caused by
+
+the sheer number of OpenGL extensions that modern systems support (the game
+
+tries to print them to the console, and in doing so causes a buffer overflow
+
+because the string containing all of the extensions is larger than the game
+
+expected). The only noticeable difference my tweaks have caused (besides the
+
+fact that you now can play the game) is that this string of OpenGL extensions
+
+is no longer printed to the terminal (which I doubt most people care about,
+
+anyway). I promise I made no tweaks to functionality or controls that would
+
+make it differ from the original.
+
+
+With that out of the way here is how to compile it:
+
+For the OpenGL GLX version (the high-quality version most sane people want),
+
+go to the directory 'WinQuake' and type
+
+    $ make build_release
+
+If you are missing libraries, headers or whatnot, it will let you know about
+
+it quite loudly. You will need a few headers from the linux kernel; if you
+
+use ubuntu or an ubuntu variant, the headers should be under something like
+
+/usr/src/linux-headers-3.5.0-44/arch/x86/include
+
+and
+
+/usr/src/linux-headers-3.5.0-44-generic/include
+
+These will have to be edited in the makefile if you have a different version
+
+or architecture of the kernel than I did. Search one of the above strings to
+
+find where I included them. Replace them appropriately with your kernel
+
+versions. If you don't have sources, they are obtainable from most package
+
+managers, including apt. A few other paths may have to be changed in the
+
+Makefile that I hardcoded, but you can figure those out I think. Good luck!
+
+
+After building, it will be in the directory 'releasei386'.
+
+You will need to copy the directory 'id1' from a quake CD-ROM
+
+and place it in the 'bin' directory that your compiled game is in.
+
+-Wyatt Ward, 2013-01-05 23:02 EST
+
+