aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrian Kummerlaender2015-02-27 21:57:38 +0100
committerAdrian Kummerlaender2015-02-27 21:57:38 +0100
commit299781bccc5c7d1b212198b5a9a55ee9447603c5 (patch)
tree2c94097bb005c7158c9cff1c33b894d6ecad9566
parent741e4550312a9bf618602c1708745e0ceaf455ec (diff)
downloadTypeAsValue-299781bccc5c7d1b212198b5a9a55ee9447603c5.tar
TypeAsValue-299781bccc5c7d1b212198b5a9a55ee9447603c5.tar.gz
TypeAsValue-299781bccc5c7d1b212198b5a9a55ee9447603c5.tar.bz2
TypeAsValue-299781bccc5c7d1b212198b5a9a55ee9447603c5.tar.xz
TypeAsValue-299781bccc5c7d1b212198b5a9a55ee9447603c5.zip
Updated `README.md` to mention the examples and added build instructions
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 92a1c35..59b07ec 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,8 @@ This library is a expanded reimplementation of my previous attempt at this probl
>
>::value;
+More extensive examples are available in the form of implementations of the [Sieve of Eratosthenes](https://github.com/KnairdA/TypeAsValue/tree/master/example/prime) as well as of a [Turing machine](https://github.com/KnairdA/TypeAsValue/tree/master/example/turing).
+
## Current features
* guaranteed evaluation during compile time
@@ -34,6 +36,17 @@ This library is a expanded reimplementation of my previous attempt at this probl
* `static_assert` based test cases for all of the above
* MIT license
+## Building
+
+As _TypeAsValue_ is completely implemented via template metaprogramming it is a header only library and as such may only be built in conjunction with the code which is making use of it. This means that one may use a arbitrary build system in practice while the `static_assert` based test cases and example applications make use of _CMake_ and can be compiled as follows:
+
+ git clone "https://github.com/KnairdA/TypeAsValue.git"
+ cd TypeAsValue # respectively "cd TypeAsValue/example/{turing|prime}"
+ mkdir build
+ cd build
+ cmake ..
+ make
+
## Requirements
* C++ compiler with support for C++14