From b375a6922e5112fb3a012cbaae42106549411726 Mon Sep 17 00:00:00 2001
From: Bardur Arantsson <bardur@scientician.net>
Date: Sat, 31 Jul 2010 12:12:16 +0200
Subject: Rename "building.txt" to "README.txt" and add "BUGS.txt".

---
 BUGS.txt     |  5 ++++
 README.txt   | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 building.txt | 82 ------------------------------------------------------------
 3 files changed, 87 insertions(+), 82 deletions(-)
 create mode 100644 BUGS.txt
 create mode 100644 README.txt
 delete mode 100644 building.txt

diff --git a/BUGS.txt b/BUGS.txt
new file mode 100644
index 00000000..ddac58c3
--- /dev/null
+++ b/BUGS.txt
@@ -0,0 +1,5 @@
+Known Bugs:
+===========
+
+- If you save the game during the Thieves Quest in Bree, it will not be able to load.
+- Under Linux the X11 front-end does not work properly when NumLock is on.
diff --git a/README.txt b/README.txt
new file mode 100644
index 00000000..463d648c
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,82 @@
+Using the CMake build system
+============================
+
+There are basically two options for how to run ToME once built.
+
+
+
+Option #1 : Run ToME from the build directory
+=============================================
+
+Simply run the commands below.
+
+       $ cmake .
+       $ make
+
+You should now be able to run
+
+       $ ./src/tome2
+
+to start ToME.
+
+This is currently the recommended option.
+
+
+
+Option #2: Run ToME from a system install location
+==================================================
+
+Run
+
+        $ cmake -DSYSTEM_INSTALL:BOOL=true .
+        $ make
+        $ sudo make install
+
+You can now run ToME from anywhere.
+
+You can also use DESTDIR when installing to a different location
+(useful with e.g. stow or when building distribution packages).
+
+
+Compiling on Ubuntu
+===================
+
+If you're having trouble compiling on an Ubuntu install you are
+probably missing the
+
+    build-essential
+
+package.
+
+Each frontend requires the additional packages listed below:
+
+   X11: libx11-dev
+   SDL: libsdl-image1.2-dev, libsdl-ttf2.0-dev
+   ncurses: libncurses5-dev
+
+
+Compiling on OpenBSD
+====================
+
+As of February 2010, the OpenBSD package cmake-2.4.8p2 is too old for
+building ToME. You may need to compile a newer version of CMake.
+
+If you have X11, then a bug in CMake may cause a linker error when
+linking the 'tome' executable. As a workaround, set the environment
+variable LDFLAGS=-L/usr/X11R6/lib when running CMake. Example:
+
+       $ env LDFLAGS=-L/usr/X11R6/lib cmake .
+       $ make
+
+The SDL frontend also requires these packages: sdl-image, sdl-ttf
+
+
+Compiling on Windows using MinGW
+================================
+
+(See http://www.mingw.org/)
+
+To compile on Windows using MinGW, use the commands
+
+       $ cmake -G "MinGW Makefiles"
+       $ mingw32-make
diff --git a/building.txt b/building.txt
deleted file mode 100644
index 463d648c..00000000
--- a/building.txt
+++ /dev/null
@@ -1,82 +0,0 @@
-Using the CMake build system
-============================
-
-There are basically two options for how to run ToME once built.
-
-
-
-Option #1 : Run ToME from the build directory
-=============================================
-
-Simply run the commands below.
-
-       $ cmake .
-       $ make
-
-You should now be able to run
-
-       $ ./src/tome2
-
-to start ToME.
-
-This is currently the recommended option.
-
-
-
-Option #2: Run ToME from a system install location
-==================================================
-
-Run
-
-        $ cmake -DSYSTEM_INSTALL:BOOL=true .
-        $ make
-        $ sudo make install
-
-You can now run ToME from anywhere.
-
-You can also use DESTDIR when installing to a different location
-(useful with e.g. stow or when building distribution packages).
-
-
-Compiling on Ubuntu
-===================
-
-If you're having trouble compiling on an Ubuntu install you are
-probably missing the
-
-    build-essential
-
-package.
-
-Each frontend requires the additional packages listed below:
-
-   X11: libx11-dev
-   SDL: libsdl-image1.2-dev, libsdl-ttf2.0-dev
-   ncurses: libncurses5-dev
-
-
-Compiling on OpenBSD
-====================
-
-As of February 2010, the OpenBSD package cmake-2.4.8p2 is too old for
-building ToME. You may need to compile a newer version of CMake.
-
-If you have X11, then a bug in CMake may cause a linker error when
-linking the 'tome' executable. As a workaround, set the environment
-variable LDFLAGS=-L/usr/X11R6/lib when running CMake. Example:
-
-       $ env LDFLAGS=-L/usr/X11R6/lib cmake .
-       $ make
-
-The SDL frontend also requires these packages: sdl-image, sdl-ttf
-
-
-Compiling on Windows using MinGW
-================================
-
-(See http://www.mingw.org/)
-
-To compile on Windows using MinGW, use the commands
-
-       $ cmake -G "MinGW Makefiles"
-       $ mingw32-make
-- 
cgit v1.2.3