Hacking:Building/en

Getting the sources
Main repository: https://bitbucket.org/dismine/valentina

Mirror on GitHub: https://github.com/dismine/Valentina

Note. Path to the source code after extraction should not contains spaces.

From the download section
This method recommended for newbies. Just download the Valentina's source code from the downloads section and extract it.

In this case you have two options:
 * Use tab Tags if you wanna get code for a specific version.


 * Use tab Branches if you wanna get code for develop branch. More about our branching model.

With Mercurial
This is more advanced way getting Valentina's source code. Please, visit Hacking:Tools for more information.

Mac OS X

 * Xcode.
 * The last Qt version for OS X from the official website: Download Qt.
 * (optional) TortoiseHG.
 * (optional) Mercurial that shipped with TortoiseHG can't be reached outside. So, if you want nice tag hash number in dialog About App install mercurial independent for this.

Windows

 * The last Qt version for MinGW from the official website: Download Qt.
 * (optional) TortoiseHG.

''Note. Valenina's source code can be compiled with Visual Studio, but without support creating an installer.''

Linux

 * g++ (at least GCC 4.6 is needed and GCC 4.8 is recommended)
 * Qt 5.0.0 and higher required. Qt 5.2.1 and higher recommended.
 * (optional) ccache. Recommended for speed up often re-compilations.

You can find all our scripts for creating packages in a folder /dist/.

Configuring and building
The installed toolchains have to match the one Qt was compiled with.

Build keys
Depend on your purposes you can build Valentina with different keys:


 * noTests - disable compiling tests. Use if you don't need tests and what to speed up compilation time.
 * noRunPath - disable adding Rpath attribute. Works only for Linux.
 * no_ccache - have sens only on Linux. Disable using ccache for speed up compilation. PCH will be used instead.
 * noDebugSymbols - By default for release mode debug symbols will be placed outside of binary file. We use them for debugging and sending crash reports on Windows. Have sens only for Linux/Windows with GCC.
 * debug - Compile the project in debug mode.

By default all keys are disabled.

Building from command line
Usual way to build sources is described below, however on Windows and Linux you have the opportunity to build packages. Mac OS X users will get package automatically.

Note. In order to build and use Valentina on Windows, the PATH environment variable needs to be extended.

Building with Qt Creator
Some more advanced users may find using IDE more preferable choice. Please, read Hacking:Tools.

Note. Building with Qt Creator on Windows and Linux doesn't support creating packages.

Mac OS X
All you need is to find Valentina in the build directory and move it to the Applications folder.

Usually path is /src/app/valentina/bin/Valentina.

Requirements for version 0.4.x and early
Install NSIS from the download page.

Requirements for version 0.5.x and later
Install Inno Setup 5 unicode from the download page.

Code signing
Note. This option is available only for Inno Setup.

In some cases you may want to create a signed installer. For this you should:
 * Buy a certificate.
 * Export it to Windows.
 * Install Microsoft signtool.exe.
 * Set path to the binary in the PATH variable.
 * Configure InnoSetup.
 * 1) Open the file /dist/win/inno/valentina.iss with Inno Setup Compiler.
 * 2) Select Tools > Configure Sign Tools.
 * 3) Select Add button.
 * 4) Enter Name of the Sign Tool (MySign).
 * 5) Enter an associated Command (signtool.exe sign /v /a /n $qSeamly, LLC$q /t http://timestamp.comodoca.com/authenticode /d $qPatternmaking program$q $f).
 * 6) Uncomment string SignTool=MySign
 * Done.

SignTool.exe options

/v - Displays verbose output regardless of whether the command runs successfully or fails, and displays warning messages.

/a - Automatically selects the best signing certificate. Sign Tool will find all valid certificates that satisfy all specified conditions and select the one that is valid for the longest time. If this option is not present, Sign Tool expects to find only one valid signing certificate.

/n SubjectName - Specifies the name of the subject of the signing certificate. This value can be a substring of the entire subject name.

/t URL - Specifies the URL of the time stamp server. If this option (or /tr) is not present, the signed file will not be time stamped. A warning is generated if time stamping fails. This option cannot be used with the /tr option.

/d - Desc specifies a description of the signed content.

InnoSetup Constants

$q is an Inno Setup constant representing a quote.

$f is a constant containing the name and path of the setup EXE created by Inno Setup.

Building

 * 1) Open Windows Qt command prompt window.Qt terminal.png
 * 2) Go to scripts folder. Just find full path to the folder, copy it and run command inside the command prompt window:.
 * 3) Run command  . It will run the  script for building and creating an installer. Wait until the end of the operation.
 * 4) The script creates folder build on the same level with scripts, where in the end you will find your installer.
 * 5) Find an installer inside build/package folder.

Please, read information about fixing Issues with build.

Debian package

 * Install tool


 * Create directory deb_build

If you want sign package
 * Copy source directory to *deb_build*
 * Copy *debian/* directory from *dist/debian* to root source directory.
 * In root source directory with *debian/* directory run:

or

if not.

That's all. In directory deb_build you will find deb package.

Note. If your deb package broken and you can't delete him use these two commands. Run commands below as a root in Debian, preceded by sudo in Ubuntu :

For example if name of package was **valentina**:

Gentoo
For Gentoo we provide ebuild scripts. You can find them on download page.

Slackware
Find and use our SlackBuild script inside the /dist/SlackBuild folder.

Additionaly you can find templates for scripts in folder  /dist/ebuild.

Issues with build
If you have issues with build Valentina check if you satisfied all dependencies. If this not help, create new issue in the issues tracker or new topic in the forum. Add information about your system and full log of compilation. We also need information about which branch did you fail try to build.

Currently known issue, and solution, on building with QtCreator 3.4.0 based on Qt 5.4.1 on Windows 8 64-bit with Avira AntiVirus Pro version 15.0.10.434 (as of June 11 2015): Build fails with 'file previously exists' errors when writing build files to destination directory. Problem is based on Avira scanning each file causing delay, Qt retries writing the file and generates the error. Other versions of Qt Creator and Avira may exhibit similar behavior. Set Avira Real-Time Protection to 'off' before building.

Also look at Hacking:Problems_and_solutions.