From 81f16bef7d586df85baf5ac43d383684bacc4ac4 Mon Sep 17 00:00:00 2001 From: tastytea Date: Tue, 25 May 2021 14:20:45 +0200 Subject: [PATCH] Improve compile instructions. --- README.adoc | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 87ce7ac..2816a8a 100644 --- a/README.adoc +++ b/README.adoc @@ -70,6 +70,16 @@ emerge -a app-text/epubgrep * Optional ** Tests: link:{uri-catch}[Catch] (tested: 2.13 / 1.10) +==== Install dependencies in Debian or Ubuntu + +Or distributions that are derived from Debian or Ubuntu. You will need at least +Debian buster or Ubuntu bionic. + +[source,shell] +-------------------------------------------------------------------------------- +apt install build-essential cmake libboost-program-options-dev libboost-locale-dev libboost-regex-dev gettext libarchive-dev libfmt-dev asciidoc +-------------------------------------------------------------------------------- + ==== Get sourcecode ===== Release @@ -85,14 +95,18 @@ git clone https://schlomp.space/tastytea/epubgrep.git ==== Compile +In a terminal, go to the directory where you unpacked / cloned the source code +and then: + [source,shell] -------------------------------------------------------------------------------- mkdir -p build && cd build cmake .. cmake --build . -- --jobs=$(nproc --ignore=1) -# cd tests && ctest -------------------------------------------------------------------------------- +To install, run `make install`. To run the tests, run `cd tests && ctest`. + .CMake options: * `-DCMAKE_BUILD_TYPE=Debug` for a debug build. * `-DWITH_TESTS=YES` if you want to compile the tests.