Hacking:Building

Getting the sources
Clone from the Seamly2D repository on GitHub. In Git, create a feature branch to hold your changes.

Basic Software Prerequisites:

 * Qt 5.15.2 (includes Qt, QtCreator, QtChooser, and Qt Maintenance Tool)
 * Git or Github Desktop for Windows and MacOS
 * Compiler - MSVC 2022, gcc, and g++ are included with QtCreator, and you can add or update them using the Qt Maintenance Tool (Maintenance.exe).
 * Pdftops (from XpdfReader or poppler) - Required to create PS or EPS layout files.
 * Check the sections below for your operating system to find additional installation requirements.

Development methods and styles:

 * GitHub Flow workflow
 * GibHub commit message style guide
 * GitHub issue description style guide

Build method:
___________________________________________________
 * Read more about code styles and other developer items of interest on our Developer wiki.
 * Review our GitHub Action CI script.

Build on Linux
These instructions apply in general to all distros


 * Install Qt 5.15.2. Example for Ubuntu 18.04: Install the following packages to have Qt5 build environment ready:

$ sudo apt install -y libfuse2 qt5-qmake qtbase5-dev libqt5xmlpatterns5-dev libqt5svg5-dev qttools5-dev-tools

Example for Ubuntu 18.04:
 * Install QtCreator https://wiki.qt.io/VendorPackages
 * Install Additional libraries
 * gnu compiler
 * poppler (pdftops)

$ sudo apt install -y build-essential git poppler-tools


 * Build and install:

$ qmake Seamly2D.pro CONFIG+=noDebugSymbols $ make -j$(nproc) $ sudo make install

Note: The default prefix for command `make install` is `/usr`. To define another prefix, build with qmake's PREFIX option. This example sets `/usr/local` as the new prefix for Seamly's installation binary files:

$ qmake PREFIX=/usr/local Seamly2D.pro CONFIG+=noDebugSymbols

___________________________________________________
 * Copy pdftops to Seamly build directory if you need to create post script (.ps and .eps) pattern piece layouts.

Build on MacOSX and Windows 10/11
Step 1: MacOS only
 * Read about Qt for macOS here
 * Install Xcode 11
 * Setup/validate build environment. Read more here.
 * Switch to Xcode: `sudo xcode-select --switch /Applications/Xcode.app`
 * Validate clang compiler points to Xcode: `xcrun -sdk macosx -find clang`
 * Validate SDK version (macOS 10.15): `xcrun -sdk macosx --show-sdk-path`
 * Install Xpdf: `sudo port install xpdf`

Step 2: Both MacOS and Windows Note: (Qt Maintenance Tool is always installed with Developer & Designer Tools - this will be highlighted)
 * Download & run the Qt unified installer. Create a Qt account for open source Community Edition if you don't have one.
 * Select:
 * Custom Installation
 * Qt - _Minimize your options, otherwise your download size could be in Gs_
 * Qt 5.15.2
 * MSVC 2019
 * Qt Debug Information Files
 * Developer and Designer Tools
 * Qt Creator
 * Qt Creator CDB Debugger Support
 * Debugging Tools for Windows
 * Qt Creator Debug Symbols

Step 3: Windows only [Control Panel | System And Security | System | Advanced Tab | Environment Variables button]
 * Download XpdfReader for Windows. Extract to `C:/Program Files`. Rename folder to `:/Program Files/Xpdf`.
 * Read about Qt for Windows here.
 * Add Qt and QtCreator directories to the Windows PATH environment variable through Control Panel:

Step 4: Both MacOS and Windows
 * To build with Qt's *QtCreator* IDE:
 * Create your compiler kit. Read more about adding compilers on the Qt website.
 * Complete your build settings. Read more about build settings here.
 * Open the Seamly2D project with 'File > Open File or Project'. Navigate to the 'seamly2d/src' directory and select 'Seamly2D.pro'.
 * Open the Configure Project tab and select your compiler kit. Read more here.
 * Build with the 'Build and Run Kit Selector' icon, or use 'Build' and 'Run' from the Tools menu. Read more here.
 * To build with Qt's *qmake* from a terminal window:
 * Read more about jom here.
 * Read more about nmake here.

cd $SOURCE_DIRECTORY\build qmake ..\Seamly2D.pro CONFIG+=noDebugSymbols nmake     # (or jom. Assign multiple CPUs to speed up compilation time but don't use all - leave at least one CPU for your OS.)
 * Copy the `C:\Program Files\Xpdf\bin64\pdftops.exe` (or bin32) file to the Seamly build directory to enable the creation of post script (.ps and .eps) pattern piece layouts.