Skip to content

BUILD.md

Latest commit

 

History

History
116 lines (77 loc) · 3.4 KB

BUILD.md

File metadata and controls

116 lines (77 loc) · 3.4 KB
Raw

Build from Source (Windows)

This project is standardized around a single primary build flow on Windows:

  1. MSVC 2022 toolchain
  2. Qt 6.x (msvc2022_64 kit)
  3. CMake + Ninja
  4. vcpkg manifest mode

Quick Start

git clone --recurse-submodules https://github.com/dduongtrandai/LA-Studio.git
cd LA-Studio
.\scripts\bootstrap.bat

The repository pins the llama.cpp revision used for the public ABI headers as a Git submodule under third_party/llama.cpp. If the repository was cloned without submodules, initialize it before configuring CMake:

git submodule update --init --recursive

LA Studio does not build or link llama.cpp; the headers are used at compile time while the selected llama.dll and ggml.dll are loaded at runtime.

After a successful build, executable output is:

out/build/windows-msvc-release/LA Studio.exe

Prerequisites

Install these before running bootstrap:

  1. Visual Studio 2022 (or Build Tools) with MSVC x64 toolchain
  2. Qt 6.5+ with msvc2022_64 kit
  3. CMake 3.21+
  4. Ninja
  5. Git

Bootstrap Behavior

scripts/bootstrap.ps1 performs:

  1. Tool checks (git, cmake, ninja)
  2. Qt detection from -QtRoot, LA_QT, or common C:\Qt\... paths
  3. vcpkg detection from -VcpkgRoot, VCPKG_ROOT, common paths, or local clone to .deps/vcpkg
  4. Build execution via scripts/build.ps1
  5. Normal deploy builds cache eSpeak NG 1.52.0 in .deps/espeak-ng and stage it under out/build/<preset>/espeak-ng with libespeak-ng.dll and espeak-ng-data.

Common Commands

Default release build:

.\scripts\bootstrap.bat

Faster development build (skip deployment step):

.\scripts\bootstrap.bat -SkipDeploy

The -SkipDeploy form intentionally does not stage eSpeak NG. Run the default command before launching the packaged application or validating dubbing phoneme counts.

Clean rebuild:

.\scripts\bootstrap.bat -Clean

Explicit Qt path:

.\scripts\bootstrap.bat -QtRoot C:\Qt\6.9.3

Use MinGW preset (advanced path):

.\scripts\bootstrap.bat -Preset windows-mingw-release -QtRoot C:\Qt\6.9.3

CMake Presets

Primary presets:

  1. windows-msvc-release
  2. windows-msvc-debug
  3. windows-mingw-release

Legacy aliases (x64-release, x64-debug, mingw-release) are retained for compatibility only.

Debug builds keep the console attached for developer logging. All non-Debug Windows builds are packaged as GUI apps, so the terminal is hidden when LA Studio.exe opens.

Incremental Build and Build Speed

By default, CMake + Ninja already performs incremental builds. If you only change a few source files, only affected targets should rebuild.

If your build feels slow during daily development, the most common reason is deployment work after compile (for example, windeployqt), not full recompilation.

Recommended workflow:

  1. Use .\scripts\bootstrap.bat -SkipDeploy while coding to reduce build time.
  2. Run .\scripts\bootstrap.bat (without -SkipDeploy) before packaging, sharing binaries, or validating runtime dependencies.
  3. Use -Clean only when you really need a full rebuild (toolchain change, cache corruption, major dependency switch).

Notes

  1. CMakeUserPresets.json is optional and user-local; it is not required for the official build path.
  2. CI and local development should use scripts/bootstrap.ps1 or scripts/build.ps1 with explicit arguments.