From 8c146111028aa82dce80b0d7da3069c2810ceea1 Mon Sep 17 00:00:00 2001 From: eidheim Date: Tue, 30 Jul 2019 21:02:47 +0200 Subject: [PATCH] Moved the dependency installation instructions to README.md as suggested in https://github.com/openjournals/joss-reviews/issues/1592#issuecomment-515909842 --- README.md | 21 ++++++++++++++++++++- docs/dependency_install.md | 23 ----------------------- 2 files changed, 20 insertions(+), 24 deletions(-) delete mode 100644 docs/dependency_install.md diff --git a/README.md b/README.md index 91d7304..87db4d8 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,26 @@ Particularly, the JSON-POST (using Boost.PropertyTree) and the GET /match/[numbe * Boost is required to compile the examples * For HTTPS: OpenSSL libraries -See [dependency installation instructions](https://gitlab.com/eidheim/Simple-Web-Server/blob/master/docs/dependency_install.md) for further information. +Installation instructions for the dependencies needed to compile the examples on a selection of platforms can be seen below. +Default build with Boost.Asio is assumed. Turn on CMake option `USE_STANDALONE_ASIO` to instead use standalone Asio. + +### Debian based distributions + +```sh +sudo apt-get install libssl-dev libboost-filesystem-dev libboost-thread-dev +``` + +### Arch Linux based distributions + +```sh +sudo pacman -S boost +``` + +### MacOS + +```sh +brew install openssl boost +``` ## Compile and run diff --git a/docs/dependency_install.md b/docs/dependency_install.md deleted file mode 100644 index 76772ef..0000000 --- a/docs/dependency_install.md +++ /dev/null @@ -1,23 +0,0 @@ -# Dependency installation instructions - -Installation instructions for the dependencies of the example files on a selection of platforms. - -Default build with Boost.Asio is assumed. Turn on CMake option `USE_STANDALONE_ASIO` to instead use standalone Asio. - -## Debian based distributions - -```sh -sudo apt-get install libssl-dev libboost-filesystem-dev libboost-thread-dev -``` - -## Arch Linux based distributions - -```sh -sudo pacman -S boost -``` - -## MacOS - -```sh -brew install openssl boost -```