Follow these instructions to install, build, and verify ADAPT on MacOS.

I. System Requirements

  • Minimum 15GB of free space
  • 2 CPU cores
  • Minimum 4GB RAM for building.

II. Install ADAPT

  1. Clone the ADAPT GitHub repository.

    brew install git
    git clone https://github.com/adapt-toolkit/mufl-poc-cpp.git
    
  2. Navigate to the build directory.

    cd <adapt_toolkit_install_directory>/mufl-poc-cpp
    

III. Build ADAPT on Monterey 12.3.1 on 2022.04.05

Use Docker and Docker Compose for clean builds or compile everything directly in the GitHub repository.

Docker Build

  1. If you haven’t yet installed Docker Desktop, do so now using these instructions.

  2. Either:

    • Pull the build dependencies container (~10GB).
    docker pull adaptframework/build-dependencies
    
    • Or build the dependencies.
    docker build . -f docker/build-dependencies/Dockerfile -t adaptframework/build-dependencies:latest
    
  3. Run the builds required for your use case.

    docker-compose up build-gpp-native
    docker-compose up build-gpp-nitro
    docker-compose up build-clang-native
    docker-compose up build-emcc-wasm
    docker-compose up build-gpp-native-debug
    docker-compose up build-gpp-nitro-debug
    docker-compose up build-clang-native-debug
    docker-compose up build-emcc-wasm-debug
    

Native Build

  1. Install Xcode.

  2. Install the MUFL compiler.

    ./setup.sh --install-compiler
    
  3. Relaunch the shell.
  4. Install the dependencies.

    ./setup.sh --install-rust
    ./setup.sh --install-emsdk
    
  5. Export the necessary variables.

    source ~/.cargo/env
    source ../emsdk/emsdk_env.sh
    
  6. Configure the repository and build the dependencies.

    ./setup.sh
    
  7. Run the builds required for your use case.

    ./scripts/build-gpp-native.sh
    ./scripts/build-gpp-native-debug.sh
    ./scripts/build-gpp-nitro.sh
    ./scripts/build-gpp-nitro-debug.sh
    ./scripts/build-clang-native.sh
    ./scripts/build-clang-native-debug.sh
    ./scripts/build-emcc-wasm.sh
    ./scripts/build-emcc-wasm-debug.sh
    
  8. Run the tests relevant to your use case.

    ./scripts/test-gpp-native.sh*
    ./scripts/test-gpp-native-debug.sh*
    ./scripts/test-gpp-nitro.sh*
    ./scripts/test-gpp-nitro-debug.sh*
    ./scripts/test-clang-native.sh*
    ./scripts/test-clang-native-debug.sh*
    ./scripts/test-emcc-wasm.sh*
    ./scripts/test-emcc-wasm-debug.sh*
    

IV. Install Language Server (Optional)

Refer to these installation instructions to install the MUFL language server extension for VS Code.