CMake Integration

This documentation provides step-by-step instructions for integrating, building, and installing the BashSpark library using CMake.

Using CMake for Integration

To utilize this project in your own, integrate it via CMake by adding the following lines to your CMakeLists.txt file:

# Include FetchContent
include(FetchContent)
 
# Fetch the repository
FetchContent_Declare(
        bashspark
        GIT_REPOSITORY https://github.com/dante19031999/bashspark.git
        GIT_TAG master
)
FetchContent_MakeAvailable(bashspark)
 
# Define your library
add_library(foo ...)
 
# Link your library with BashSpark
target_link_libraries(foo PRIVATE BashSpark::BashSpark)

Available Alias Options

You can choose from several aliases depending on your needs:

• BashSpark::ABashSpark: static library.
• BashSpark::FBashSpark: static library with position-independent code.
• BashSpark::SBashSpark: dynamic library.
• BashSpark::BashSpark: default dynamic library.

Generating the Documentation

This project includes comprehensive documentation detailing its functionality. To generate the documentation, follow these steps:

1. The CMake configuration file includes a dedicated "doc" target.
2. Executing this target will generate the Doxygen documentation in ${PROJECT_DIR}/docs.
3. Access the documentation at ${PROJECT_DIR}/docs/html/index.html.

The library Doxygen Awesome is used to enhance documentation aesthetics.