first version

Setting-up-a-development-environment.md

@@ -0,0 +1,53 @@
+# Linux
+## Setting up your system
+Make sure you have a compiler with C++11 support installed, such as gcc 5.
+
+### Generic list of dependencies
+In order to build dindexer you will need:
+
+* boost (program_options, system, filesystem) 1.53
+* libpq (for PostgreSQL)
+* libmagic
+* libyaml-cpp 0.5.1
+* libblkid (only needed if you build with DINDEXER_WITH_MEDIA_AUTODETECT enabled)
+* libreadline
+
+### Ubuntu Xenial
+
+```bash
+    sudo apt-get install libblkid-dev libyaml-cpp-dev libmagic-dev libpq-dev libboost1.60-all-dev libboost-program-options1.60-dev cmake git
+```
+
+### Gentoo
+Run as root:
+
+```bash
+    emerge -av dev-db/postgresql dev-cpp/yaml-cpp dev-libs/boost dev-util/cmake dev-vcs/git
+```
+
+## Getting the code
+Make sure you have git installed on your system, then clone the repository with the commands:
+
+```bash
+    git clone https://github.com/KingDuckZ/dindexer.git
+    git submodule update --init
+```
+
+At this point you have the full source and you are ready to start browsing the code.
+
+## Building
+If you are not familiar with cmake, this short video shows how to start building on an Ubuntu system, assuming you have all the required dependencies.
+
+[![asciicast](https://asciinema.org/a/46081.png)](https://asciinema.org/a/46081)
+
+Or, if you prefer a step-by-step list of commands:
+
+```bash
+    cd ~
+    mkdir -p dindexer_build/debug
+    cd dindexer_build/debug
+    # in the following command replace ~/dindexer with the path to where you cloned the git repository
+    cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DPBL_WITH_TESTS=off ~/dindexer
+    cmake --build .
+    ctest
+```