Skip to content

build.md

Latest commit

 

History

History
55 lines (44 loc) · 1.92 KB

build.md

File metadata and controls

55 lines (44 loc) · 1.92 KB

Text-based Desktop Environment

Building from source

Unix

Build-time dependencies

  • C++20 compiler: GCC 12 or Clang 14
  • cmake (minimum version v3.22)
  • git
  • FreeType
  • HarfBuzz
  • Lua (minimum version v5.4)

Examples of installing dependencies:

OS Dependency installation command Notes
Linux sudo apt install libfreetype-dev libharfbuzz-dev liblua5.4-dev git cmake
FreeBSD pkg install freetype2 harfbuzz lua54 cmake Best results with GCC compiler and 6GB of RAM.
MacOS brew install freetype harfbuzz lua cmake

Use any terminal as a build environment

git clone https://github.com/directvt/vtm.git
cd vtm
cmake . -B bin
cmake --build bin
sudo cmake --install bin
vtm

Installation Note:

  • By default, files are installed to system directories (e.g., /usr/local/bin/). If you want to install vtm to a user directory without using sudo (e.g., $HOME/.local/; ensure that this directory is added to your $PATH), use the CMAKE_INSTALL_PREFIX flag during the cmake configuration step: 
    cmake . -B bin -DCMAKE_INSTALL_PREFIX=$HOME/.local
cmake --build bin
cmake --install bin

Windows

Build-time dependencies

  • MSVC
    • Desktop Development with C++
    • C++ CMake tools for Windows
    • Git for Windows
    • vcpkg package manager
  • Dependencies managed by vcpkg:
    • FreeType
    • HarfBuzz
    • Lua

To manually compile vtm, launch Visual Studio and clone the repository https://github.com/directvt/vtm.git, after cloning is complete, double-click on the Folder View in Solution Explorer, wait for the dependencies to initialize (may take several minutes), select the required configuration on the top menu toolbar, and click the Build All menu button.