Skip to content

Latest commit

 

History

History
154 lines (112 loc) · 3.64 KB

BUILD.md

File metadata and controls

154 lines (112 loc) · 3.64 KB
Raw

Build instructions

Generic instructions to help with compiling e2 SAT Editor on different platforms.

Utils scripts in scripts folder.

  • For Linux or BSD or Unix use scripts/build-qmake.sh
  • For macOS with Xcode use scripts/build-darwin.sh
  • For Windows with MinGW-64 use scripts/build-mingw.sh

Required dependencies

Requirements needed to compile:

  • build tools (qmake cmake ninja)
  • C++17 (gcc clang)

Libraries required as dependencies:

  • qt6-base | qt5-base
  • qt6-base-dev | qt5-base-dev
  • qt6-translations | qt5-translations
  • libcurl4 libcurl-dev

Additional requirements for WebAssembly:

  • Qt for WebAssembly to cross-compile
  • emscripten
  • emsdk
  • ninja
  • python3

Windows – MinGW-64

Compiling with CMake and MinGW-64 for Windows in Linux host.

In order to cross-compile, the following packages are required:
base-devel, cmake, mingw-w64-cmake-static, mingw-w64-qt6-base-static, mingw-w64-curl

To build with shared libraries, the following:
mingw-w64-cmake, mingw-w64-qt6-base

Tip

I used custom Arch Linux repositories: Martchus/PKGBUILDs from @Martchus

With MSYS2, the following:
cc, cmake, ninja, qt6-base, qt6-translations, curl

Clone the repository, then from the source directory, execute commands:

cd src
x86_64-w64-mingw32-cmake-static -B build
cmake --build build

For older Windows 32-bit versions:

cd src
i686-mingw32-cmake-static -B build -DWITH_QT5=ON
cmake --build build

macOS

Compiling with qmake or CMake in macOS host.

In order to compile, the following packages are required:
Xcode, Xcode Command Line Tools, Qt, curl

And at your choice:
cmake or qmake

Clone the repository, then from the source directory, execute commands:

cd src
qmake -spec macx-clang e2-sat-editor.pro
make && qmake
qmake -spec macx-xcode

If you prefer CMake:

cd src
cmake -B build
cmake --build build

Linux – BSD - Unix

Compiling with qmake or CMake for Linux or BSD or Unix.

In order to compile, the following packages are required, on Arch Linux:
base-devel, qt6-base, curl

On Ubuntu, the following:
curl, libcurl4-openssl-dev
qt6-base-dev, qt6-translations-l10n
libgl1-mesa-dev, libglvnd-dev, libxcb-xkb-dev, libxkbcommon-x11-dev, libvulkan-dev

And at your choice:
cmake or qmake

Clone the repository, then from the source directory, execute commands:

cd src
qmake
make

If you prefer CMake:

cd src
cmake -B build
cmake --build build

WebAssembly – Qt Wasm

Compiling with CMake for Qt for WebAssembly on supported host.

In order to cross-compile, the following packages are required:
gcc, clang, llvm, cmake, ninja, qt6-base, emscripten, emsdk, python3

Follow the instructions from the Qt Documentation website to obtain or build Qt Wasm in your host.

Clone the repository, then from the source directory, execute commands:

export EMSDK=/path/to/emsdk
cp -R e2se-seeds/enigma_db res/enigma_db
mv src/CMakeLists.txt src/CMakeLists.txt.bak
cp dist/wasm/CMakeLists.txt src/CMakeLists.txt
cd src
./qt-everywhere-src/qtbase/bin/qt-cmake .
cmake --build .

To match the requirement of the demo, you need also e2se-seeds/enigma_db folder from the repository ctlcltd/e2se-seeds.

cp -R e2se-seeds/enigma_db res/enigma_db

Tip

An example on how to build Qt for WebAssembly from your host environment

export EMSDK=/path/to/emsdk
em++ --version
cd qt-everywhere-src
./configure -qt-host-path /path/to/Qt -platform wasm-emscripten -prefix qtbase
cmake --build . --parallel -t qtbase -t qtimageformats -t qtsvg