Getting Started

Getting Started

This quickstart gets NOMAD built and running locally for development.

Prerequisites (fill with your project's actual dependencies)

• CMake >= 3.20
• A modern C++ compiler (GCC, Clang, MSVC) with C++17/20 support
• Git
• PortAudio or JUCE or whichever audio backend you use
• SDL2 / GLFW / platform UI framework (if applicable)
• Optional: Python 3 (for build scripts), vcpkg/conan for dependency management

Clone

git clone https://github.com/currentsuspect/NOMAD.git
cd NOMAD

Out-of-source build (Unix-like)

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug
cmake --build . --parallel

Windows (MSVC)

• Open a Developer Command Prompt

mkdir build
cd build
cmake .. -G "Visual Studio 17 2022" -A x64
cmake --build . --config Debug

Run

• Executable location: build/bin/NOMAD (or build/Debug/NOMAD.exe on Windows)

./build/bin/NOMAD

First run

• If the project includes an initial demo song, open it via File → Open or run with a CLI argument:

./build/bin/NOMAD demos/hello.nomadproj

Troubleshooting

• Missing audio devices: ensure your audio backend (PortAudio/JUCE) is installed and accessible.
• Dependency errors: consider using vcpkg or Conan; add example commands here once your dependency manager is chosen.

Next steps

• Read Concepts.md to learn core application architecture.
• See Usage-Examples.md for sample projects and how to import plugins.