Skip to content

COMPILING.md

Latest commit

 

History

History
80 lines (48 loc) · 2.3 KB

COMPILING.md

File metadata and controls

80 lines (48 loc) · 2.3 KB
Raw

COMPILING Obsidian

Windows Dependencies (example using MSVC and VSCode)

  1. Download the Visual Studio Build Tools installer, and install the 'Desktop Development with C++' workload

  2. Install VSCode, as well as the C/C++ and CMake Tools extensions

  3. Using VSCode, select the 'Visual Studio Build Tools (version) Release - x86_amd64' kit for 64-bit, or the x86 kit for 32-bit

  4. Select the Release CMake build variant

  5. Click Build

Linux Dependencies (MSYS has some differences; see MSYS Cross-Compilation section below)

  1. C++ compiler and associated tools

    • packages: g++ binutils
    • if compiling with clang: clang
    • compiler and toolchain need C++17 capabilities

  2. GNU make

    • package: make

  3. CMake Utilities:

    • package: cmake

  4. Development libraries

    • packages: libfltk1.3-dev libxft-dev libxinerama-dev libjpeg-dev libpng-dev libfontconfig1-dev

  5. FLEX

    • package: flex

  6. Code formatting tools

    • package: clang-tidy
    • python package (optional, install with pip): cmakelang

Linux Compilation

Assuming all those dependencies are met, then the following steps will build the Obsidian binary. (The '>' is just the prompt)

> cmake --preset dist
> cmake --build --preset dist (-j# optional, with # being the number of cores you'd like to use)

Then, Obsidian can be launched with:

> ./obsidian

Windows Cross-Compilation on Linux using MinGW

You will need the mingw-w64 package as well (or your distro's equivalent)

Similar to the above directions:

> cmake --preset cross64 (use cross32 for a 32-bit build)
> cmake --build --preset cross64 (-j# optional, with # being the number of cores you'd like to use)

Then, Obsidian can be launched (in Windows) with:

> obsidian.exe

Windows Cross-Compilation using MSYS

You will need to install the following on top of the regular MSYS Mingw64 install:

  • package: mingw-w64-(arch)-clang-tools-extra
  • package: mingw-w64-(arch)-cmake

Similar to the above directions:

> cmake -B build -G "MSYS Makefiles"
> cmake --build build (-j# optional, with # being the number of cores you'd like to use)

Then, Obsidian can be launched (in Windows) with:

> obsidian.exe

INSTALLING Obsidian

This is a work-in-progress; needs to be revisited after the CMake conversion is finalized