Build from source

Preparation

1. Clone this repo and submodules:

   git clone --recurse-submodules https://github.com/cpeditor/cpeditor.git
   # or alternatively in two separate commands
   # git clone https://github.com/cpeditor/cpeditor.git
   # git submodule update --init --recursive
   cd cpeditor
   

2. Install Qt (5.15), CMake (3.12 or higher) and Python3 .

   • On some Linux distributions and macOS, you can install from your package manager. For example, sudo pacman -S qt5-base on Arch Linux, brew install qt@5 on macOS.
   • You can also use aqtinstall to install Qt.

3. If CMake can’t find the Qt installation path, you should set the environment variable: CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake. For example, on macOS, you can run something like export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.15.2".

4. Install KDE (kf5) Syntax Highlighting.

   • On some Linux distributions and macOS, you can install from your package manager. For example, sudo pacman -S syntax-highlighting5 on Arch Linux, Homebrew KDE and then brew install kde-mac/kde/kf5-syntax-highlighting on macOS.

   • Otherwise, you can use CMake to build and install Extra CMake Modules first and then KSH:

     cd third_party/extra-cmake-modules
     cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
     cmake --build build --config Release --target install # may require sudo
     cd ../syntax-highlighting
     cmake -B build -S . -DBUILD_HTML_DOCS=OFF -DBUILD_MAN_DOCS=OFF -DBUILD_QTHELP_DOCS=OFF -DBUILD_TESTING=OFF
     cmake --build build --config Release --target install
     

Build

• Linux/macOS:

  cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
  cmake --build build
  

• Windows:

  cmake -S . -B build
  cmake --build build --config Release
  

On Linux, you will get build/cpeditor.

On macOS, you will get build/cpeditor.app.

On Windows, you will get build\cpeditor.exe, or build\Release\cpeditor.exe. If DLLs are missing, you can add %QtPath%\%QtVersion%\%Compiler%\bin (for example, D:\Qt\5.15.2\msvc2019_64\bin) to the PATH environmental variable.