README.txt

Seamly2D
====================

Seamly2D is pattern design software to create reusable, scalable, sharable custom-fit patterns with using historical, couture and bespoke pattern techniques. Seamly2D saves time and improves fit by creating patterns that are reusable parametric CAD engineering documents.

Unlike other pattern design software, Seamly2D allows designers to have complete control of the patternmaking process. Each reusable, scalable pattern can read multi-size tables for boutique sizing *and* read individual measurement files for custom-fit.

Seamly2D is open source software released under the GPLv3+ license.  Seamly2D is available for Windows, OSX, and Linux.  Learn more about Seamly2D by joining our active, friendly community at https://forum.seamly.net

Supported platforms:
   * Windows XP SP2 (32-bit) or later
   * Ubuntu Linux 14.04 (32-bit/64-bit) or later
   * OpenSUSE 13.02 (32-bit/64-bit) or later
   * Fedora 24 (32-bit/64-bit) or later
   * Mac OS X 10.8 (64-bit) or later

Homepage and downloads     https://fashionfreedom.eu
Wiki & User Manual         https://wiki.valentinaproject.org
Forum                      https://forum.seamly.net/
Translations               https://www.transifex.com/organization/valentina
PPA for Ubuntu (stable)    ppa:susan-spencer/seamly2d
PPA for Ubuntu (develop)   ppa:susan-spencer/seamly2d-dayly-build   
IRC channel                #seamly2d on irc.freenode.net
Main repository            https://github.com/fashionfreedom/seamly2d
Doxygen docs               https://seamly2d.github.io/

Seamly2D Downloads  
================
<em>Windows</em>:
  
* [stable version](https://bintray.com/fashionfreedom/Seamly2D/Seamly2D-win_release)  
* [development version](https://bintray.com/fashionfreedom/Seamly2D/Seamly2D-win_auto-upload)  

<em>Mac OS X</em>:  

* [stable version](https://bintray.com/fashionfreedom/Seamly2D/Seamly2D-mac_release)  
* [development version](https://bintray.com/fashionfreedom/Seamly2D/Seamly2D-mac_auto-upload)  

<em>Ubuntu</em>:  

* stable version:  
sudo add-apt-repository ppa:susan-spencer/seamly2d  
sudo apt-get update  
sudo apt-get install seamly2d  
* development version:  
sudo add-apt-repository ppa:susan-spencer/seamly2d-dayly-build  
sudo apt-get update  
sudo apt-get install seamly2d  

Building Seamly2D
================

Basic Prerequisites:
   * Qt 5.7.0 or later https://www1.qt.io/download-open-source (included in Qt install)
   * Qt Creator 4.3.1 or later (to build code) https://www1.qt.io/download-open-source (included in Qt install)
   * Qt Chooser (to maintain Qt, set Qt default version) https://www1.qt.io/download-open-source (included in Qt install)
   * git (for working with repository)  https://git-scm.com/downloads
   * Read forum on building with Qt: https://forum.seamly.net/t/how-to-build-with-qt/1833

Additional:
________________
*Linux: In general, these additional tools and libraries may be required:
 g++ compiler (at least GCC 4.7 is needed and GCC 4.8 is recommended) or clang (minimum clang 3.4 (2014), current 5.0 (2017)), xpdf (pdftops), OpenGL libraries, Qt build libraries*

<em>Fedora</em>:

    sudo yum groupinstall "C Development Tools and Libraries"
    sudo yum install mesa-libGL-devel

<em>Suse</em>:

    sudo zypper install -t pattern devel_basis

<em>Ubuntu</em>:

* Install packages:
    sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
    sudo apt-get -qq update
    sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 60 --slave /usr/bin/g++ g++ /usr/bin/g++-5
    sudo apt-get install -y build-essential mesa-utils mesa-common-dev libgl1-mesa-dev
    sudo apt-get install -y poppler-utils
    sudo apt-get install -y g++-5
    sudo apt-get install -y xpdf
    sudo apt-get install -y xvfb
    sudo apt-get install -y libfontconfig1-dev libfreetype6-dev
    sudo apt-get install -y libx11-devlibxext-dev libxfixes-dev libxi-dev
    sudo apt-get install -y libxrender-dev libxcb1-dev libx11-xcb-dev libxcb-glx0-dev

    wget https://launchpad.net/ubuntu/+archive/primary/+files/ccache_3.3.4-1_amd64.deb
    sudo dpkg -i ccache_3.3.4-1_amd64.deb

* Install Qt from https://www1.qt.io/download-open-source/
* Install Qt from ppa. This will take some time.
    sudo add-apt-repository -y ppa:beineri/opt-qt592-trusty
    sudo apt-get -qq update
    sudo apt-get install -y qt59-meta-full qt59-meta-dbg-full qt59creator
* After Qt5.9 installation, run shell file to configure environment variables
    sudo chmod +x /opt/qt59/bin/qt59-env.sh
    sudo /opt/qt59/bin/qt59-env.sh

________________

 <em>MAC OSX</em>:
________________

<em>Windows</em>:

* MinGW v5.0.2 from http://mingw-w64.org/doku.php
* Xpdf v4.0.0 (xpdftools) from http://www.xpdfreader.com/download.html. Put tool pdftops.exe in the same directory with Seamly2D's binary file.

________________

The installed toolchains have to match the one Qt was configured with.

You can build from within the <em>QtCreator</em> IDE (see forum post above), or build with Qt's <em>qmake</em> from a terminal window:

    cd $SOURCE_DIRECTORY\build
    qmake ..\Seamly2D.pro -r CONFIG+=noDebugSymbols CONFIG+=no_ccache
    make (or mingw32-make or nmake or jom, depending on your platform)

Note: On some platforms e.g. Fedora, all Qt-tools come as qmake-qt5, etc. Run

    export QT_SELECT=5

prior to running <em>qmake</em>. You will not come along with just using <em>qmake-qt5</em> here.

Note: In order to build and use Seamly2D, the PATH environment variable needs to be extended to locate qmake (or qmake-qt5), moc and other Qt tools. This is done by adding your Qt's installation path (eg c:\Qt\%VERSION%\bin) to the PATH variable. Check your Qt installation to find the correct path to enter.

For newer versions of Windows, PATH can be extended through this menu:

     Control Panel|System|Advanced|Environment

Add the locations of your compiler and other build tools to your system's PATH variable. This will depend on your choice of software development environment.

Unix systems:
Default prefix for command "make install" is /usr. For using another prefix build with qmake command:

    qmake PREFIX=/usr/local PREFIX_LIB=/usr/lib/i386-linux-gnu Seamly2D.pro -r CONFIG+=noDebugSymbols CONFIG+=no_ccache

where /usr/local is a new prefix for installation binary files and /usr/lib/i386-linux-gnu is new prefix for install libraries.

Use <em>QtChooser</em> to update and set the latest QT version as default. Within the <em>QtCreator</em> IDE define your compiler and compiler kit, and assign the compiler kit to your project. This automatically defines your Path prefixes in Qt. Your operating system's path to your Qt executable files is still required in PATH system variable via your Linux's .bashrc or Windows' Control Panel.

LICENSING
================
Seamly2D is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Seamly2D is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

See LICENSE_GPL.txt file for further information

Other components released under:
* QMuParser - BSD license
* VPropertyExplorer - LGPLv2.1 license