From 9d67ae800d711415b5b821157ff6530a195a54e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrick=20L=C3=BChne?= <patrick-github@luehne.de>
Date: Sun, 14 Aug 2016 16:27:43 +0200
Subject: [PATCH] Put building instructions in a separate documentation file.

---
 README.md                    | 29 ++------------------------
 doc/building-instructions.md | 40 ++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 27 deletions(-)
 create mode 100644 doc/building-instructions.md

diff --git a/README.md b/README.md
index b4c5129..cca17ab 100644
--- a/README.md
+++ b/README.md
@@ -66,34 +66,9 @@ If you want to write your own meta encoding for `plasp`’s output, the [simple
 
 ## Building
 
-`plasp` requires a C++14 compiler (preferrably GCC ≥ 6.1 or clang ≥ 3.8), the `boost` libraries (≥ 1.55), and CMake for building.
+`plasp` requires `boost` and is built via CMake and a C++ compiler.
 
-```bash
-$ git clone https://github.com/potassco/plasp.git
-$ cd plasp
-$ mkdir -p build/release
-$ cd build/release
-$ cmake ../.. -DCMAKE_BUILD_TYPE=Release
-$ make
-```
-
-The built `plasp` binary is then located at `plasp/build/release/bin/plasp`.
-
-### Running the Tests
-
-`plasp` provides unit tests written using the [Google Test](https://github.com/google/googletest) framework.
-Before building and running the tests, make sure you have fetched the Google Test git submodule:
-
-```bash
-$ git submodule init
-$ git submodule update
-```
-
-Afterward, build and run the tests as follows:
-
-```bash
-$ make run-tests
-```
+See the [building instructions](doc/building-instructions.md) for more detail.
 
 ## Contributors
 
diff --git a/doc/building-instructions.md b/doc/building-instructions.md
new file mode 100644
index 0000000..848b26d
--- /dev/null
+++ b/doc/building-instructions.md
@@ -0,0 +1,40 @@
+# Building Instructions
+
+`plasp` requires a C++14 compiler (preferrably GCC ≥ 6.1 or clang ≥ 3.8), the `boost` libraries (≥ 1.55), and CMake for building.
+
+```bash
+$ git clone https://github.com/potassco/plasp.git
+$ cd plasp
+$ mkdir -p build/release
+$ cd build/release
+$ cmake ../.. -DCMAKE_BUILD_TYPE=Release
+$ make
+```
+
+The built `plasp` binary is then located at `plasp/build/release/bin/plasp`.
+
+To update `plasp` to the most recent version, perform the following steps:
+
+```bash
+$ cd plasp
+$ git pull
+$ cd build/release
+$ cmake .
+$ make
+```
+
+## Running the Tests
+
+`plasp` provides unit tests written using the [Google Test](https://github.com/google/googletest) framework.
+Before building and running the tests, make sure you have fetched the Google Test git submodule:
+
+```bash
+$ git submodule init
+$ git submodule update
+```
+
+Afterward, build and run the tests as follows:
+
+```bash
+$ make run-tests
+```