Skip to content

Installation

Homebrew

Ada is available through Homebrew. Homebrew is kept up to date with the recent releases of Ada.

Run the following command to install Ada to your macOS computer:

Terminal window
brew install ada-url

Build from source

Requirements

The project is self-contained and has no dependency. A recent C++ compiler supporting C++17. We test GCC 9 or better, LLVM 10 or better and Microsoft Visual Studio 2022.

Compiling

Run the following commands to compile and build Ada locally.

  1. Prepare build

    The following command prepares the build.

    Terminal window
    cmake -B build
  2. Build

    Run the following command to build Ada on your system.

    Terminal window
    cmake --build build
  3. Run tests

    Run the following ctest command to validate your build.

    Terminal window
    ctest --output-on-failure --test-dir build

Windows

Windows users need additional flags to specify the build configuration, e.g. --config Release.

Docker

The project can also be built via docker using default docker file of repository with following commands.

  1. Build

    Build and prepare the docker file

    Terminal window
    docker build -t ada-builder
  2. Run

    Run the tests

    Terminal window
    docker run --rm -it -v ${PWD}:/repo ada-builder

Amalgamation

You may amalgamate all source files into only two files (ada.h and ada.cpp) by typing executing the Python 3 script singleheader/amalgamate.py. By default, the files are created in the singleheader directory.

Terminal window
./singleheader/amalgamate.py