install.txt

How to Install YASW
-------------------
Currently, YASW has no install procedure. You can test YASW by compiling it
and running it directly from the compilation directory.

YASW is developped under Debian GNU/Linux.
It is cross-compiled for windows using http://mxe.cc (see How to release for details)
YASW ought to run on other Qt-Platforms. If you want to contribute to / port / compile YASW on other platforms, your help
is welcome!

Complile YASW
-------------
Prerequisite to build YASW is the Qt5-Plateform.
$ cd src
$ qmake
$ make

Alternative: install QT Creator, open yasw.pro and click "run".

Run YASW
--------
After compiling YASW, just go into src and run "yasw", on linux:
./yasw


How to Release
--------------
#######################
# Prepare Release
#######################
- edit changelog
- update version in constants.h
- make distclean working repository, rebuild in release, extensive test
- cross-compile to windows, small test
  - insert images
  - export to pdf

#######################
# Build source tarball
#######################
# Tag the git repository
VERSION=0.6
git tag -a yasw_${VERSION} -m "YASW version ${VERSION}"
# build the tarball (note: it contains files like .gitignore...)
git archive --prefix=yasw_${VERSION}/ yasw_${VERSION} | gzip > ../yasw_${VERSION}.tgz
# test archive (tar xvzf, qmake, make, ./yasw, play around)
# publish the tag on github:
git push --tags

#######################
# Build windows version (cross compile under linux)
#######################
# Preparation: follow steps 1; 3; 4; 5c on http://mxe.cc/#tutorial :
git clone -b stable https://github.com/mxe/mxe.git
cd mxe
make qtsvg
export PATH=/where MXE is installed/usr/bin:$PATH
# Cross-compile YASW:
cd <path to yasw root folder>
mkdir windows-build
cd windows-build
/where MXE is installed/usr/i686-pc-mingw32/qt5/bin/qmake ../src/yasw.pro CONFIG+=static
make
# build archive
VERSION=0.6
mkdir yasw_${VERSION}_Windows
cp release/yasw.exe yasw_${VERSION}_Windows/
cp ../README yasw_${VERSION}_Windows/
cp ../changelog.txt yasw_${VERSION}_Windows/
cp ../documentation/gpl.txt yasw_${VERSION}_Windows/
zip -r yasw_${VERSION}_Windows.zip yasw_${VERSION}_Windows/