diff --git a/CMakeLists.txt b/CMakeLists.txt index 6ffc14d..df6bf3b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -53,14 +53,14 @@ if(ACTSVG_BUILD_META) add_subdirectory(meta) endif() -option(ACTSVG_BUILD_WEB "Build the webpage builder interface of ACTSVG" ON) +option( "Build the webpage builder interface of ACTSVG" ON) if(ACTSVG_BUILD_WEB) add_subdirectory(web) endif() option(ACTSVG_BUILD_TESTING "Build the (unit) tests of ACTSVG" OFF) -if(ACTSVG_BUILD_TESTING OR ACTSVG_BUILD_EXAMPLES) +if(ACTSVG_BUILD_TESTING) add_subdirectory(data) endif() @@ -70,7 +70,7 @@ if(ACTSVG_BUILD_TESTING) add_subdirectory(tests) endif() -if(ACTSVG_BUILD_TESTING OR ACTSVG_BUILD_EXAMPLES) +if(ACTSVG_BUILD_TESTING) # Set up GoogleTest. option( ACTSVG_SETUP_GOOGLETEST @@ -91,7 +91,7 @@ if(ACTSVG_BUILD_TESTING OR ACTSVG_BUILD_EXAMPLES) endif() endif() -option(ACTSVG_BUILD_PYTHON_BINDINGS "Build the python bindings of ACTSVG" ON) +option(ACTSVG_BUILD_PYTHON_BINDINGS "Build the python bindings of ACTSVG" OFF) if(ACTSVG_BUILD_PYTHON_BINDINGS) find_package(Python 3.8 REQUIRED COMPONENTS Interpreter Development) option( diff --git a/README.md b/README.md index 53d9280..c5308c0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # actsvg -An SVG based C++17 plotting library for ACTS detectors, surfaces and relations. +An SVG based C++20 plotting library for ACTS detectors, surfaces and relations. This library has itself no dependency, simply for unittesting it relies on `googletest`. +In case `actsvg` is built with python bindings, also `pybind11` is used as a dependency. + ## Core module -This module has the entire definition and plotting functionality. +This module has the core definition and plotting functionality for primitives. ## Meta module @@ -36,4 +38,21 @@ An example for an endcap sheet: An example for a barrel sheet (module info display): - \ No newline at end of file + + +## Getting started + +To build `actsvg` using CMake execute the following + +```sh + cmake -GNinja -S -B -DCMAKE_INSTALL_PREFIX= + -DCMAKE_CXX_STANDARD=20 +cmake --build $bdir -j $cthreads --target install +``` + +CMake Build options are (and their defaults) +| ACTSVG_BUILD_META | Build the meta module of the project | ON | +| ACTSVG_BUILD_WEB | Build the web module of the project | ON | +| ACTSVG_BUILD_TESTING | Building the testing suite | OFF | +| ACTSVG_BUILD_PYTHON_BINDINGS | Build python bindings for the project | OFF | +