summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBardur Arantsson <bardur@scientician.net>2015-12-29 09:24:41 +0100
committerBardur Arantsson <bardur@scientician.net>2015-12-29 09:38:20 +0100
commit2864bfed31463d903c09d6a7f7105d75f6f3a088 (patch)
treeaa9ae5c6f3048b5df81e2095316903b02644007f
parente372fe0311b8237fd680d7f1da3b1c9ceb13976b (diff)
Reformat README file as Markdown
- Reformat README as Markdown - Clarify wording in places
-rw-r--r--README.md98
-rw-r--r--README.txt106
2 files changed, 98 insertions, 106 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5ef43a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,98 @@
+# Building
+
+## Prerequisites
+
+You will need to have the following libraries installed on your system
+somewhere where CMake can find them:
+
+- [jansson](http://www.digip.org/jansson/)
+- [Boost](https://www.boost.org/)
+
+Version requirements may vary somewhat, but usually you should be
+aiming for having at least a **recent** version of the above libraries.
+
+## Using the CMake build system
+
+There are basically two options for ToME runs once built and the step
+used to configure the build needs to incorporate the choice.
+
+### **Option 1:** Run ToME from the build directory
+
+**This is currently the recommended option**, but it means that you
+cannot "install" ToME as such, you just run it from the build
+directory.
+
+To configure for your system, run
+
+ $ cmake .
+ $ make
+
+You should now be able to run
+
+ $ ./src/tome
+
+to start ToME.
+
+**Important:** The current working directory must be at the root of
+the source tree for the above command to run -- if it isn't, then
+you'll get mysterious errors about ToME not being able to find files
+(at best).
+
+
+### **Option 2:** Run ToME from a system install location
+
+To configure for your system, run
+
+ $ cmake -DSYSTEM_INSTALL:BOOL=true .
+ $ make
+ $ sudo make install
+
+You can now run ToME from anywhere and it will always use the files
+installed in the system-specific location.
+
+
+## Compiling on Ubuntu
+
+To compile on an Ubuntu install, you'll need at least the
+
+- `cmake`
+- `build-essential`
+- `libjansson-dev`
+- `libboost-all-dev`
+
+packages.
+
+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 executable. As a workaround, set the environment variable
+`LDFLAGS` 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
+
+The source **MUST** be unpacked in a directory without spaces in the
+name.
+
+To configure and compile on Windows using MinGW, use the commands
+
+ $ cmake -G "MinGW Makefiles"
+ $ mingw32-make
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 90e2821..0000000
--- a/README.txt
+++ /dev/null
@@ -1,106 +0,0 @@
-Using the CMake build system
-============================
-
-There are basically two options for how to run ToME once built.
-
-
-Prerequisites
-=============
-
-You will need to have the following libraries installed
-on your system somewhere where CMake can find them:
-
- - jansson
- See http://www.digip.org/jansson/
-
- - Boost
- See https://www.boost.org/
-
-
-Version requirements may vary somewhat, but usually you should be
-aiming for having at least a *recent* version of the above libraries.
-
-
-Option #1 : Run ToME from the build directory
-=============================================
-
-Simply run the commands below.
-
- $ cmake .
- $ make
-
-You should now be able to run
-
- $ ./src/tome
-
-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. You'll also need to install the
-
- libjansson-dev
- libboost-all-dev
-
-packages.
-
-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/)
-
-The source MUST be unpacked in a directory without spaces in the
-name.
-
-To compile on Windows using MinGW, use the commands
-
- $ cmake -G "MinGW Makefiles"
- $ mingw32-make