From 3cb5de860c5426893845252fa325c03dcc3ba11e Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Thu, 30 Jun 2016 13:51:59 +1000
Subject: [PATCH] Linux support working on a basic level (builds and runs)

Add docs on building with Linux.
---
 README.md                 |   1 +
 doc/how_to_build_linux.md | 147 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 148 insertions(+)
 create mode 100644 doc/how_to_build_linux.md

diff --git a/README.md b/README.md
index 857848c4..d1261571 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@ Older versions and unstable nightly build are also available at <https://github.
 
 - [Windows](./doc/how_to_build_win.md)
 - [OS X](./doc/how_to_build_macosx.md)
+- [Linux](./doc/how_to_build_linux.md)
 
 ## Community
 
diff --git a/doc/how_to_build_linux.md b/doc/how_to_build_linux.md
new file mode 100644
index 00000000..a90f543e
--- /dev/null
+++ b/doc/how_to_build_linux.md
@@ -0,0 +1,147 @@
+# Setting up the development environment for GNU/Linux and Unix
+
+## Required software
+
+You will need to install some dependencies before you can build. Depending on your distribution you will be able to install the packages directly with the command lines below or will have to manually install:
+- git
+- gcc
+- cmake
+  - confirmed to work with 3.4.1.
+- Qt
+  - http://download.qt.io/official_releases/qt/5.5/5.5.1/
+- boost
+  - http://www.boost.org/users/history/version_1_55_0.html
+- SDL 2
+TODO: list them all?
+
+### Installing required packages on Debian / Ubuntu
+
+```
+$ sudo apt-get install build-essential cmake pkg-config libboost-all-dev qt5-default qtbase5-dev libqt5svg5-dev qtscript5-dev qttools5-dev-tools libqt5opengl5-dev libsuperlu-dev liblz4-dev libusb-1.0-0-dev liblzo2-dev libjpeg-dev libglew-dev freeglut3-dev libsdl2-dev libfreetype6-dev
+```
+
+Notes:
+* Debian doesn't seem to be a package yet for libpng 1.6, but try libpng16-dev
+* It's possible we also need libgsl2 (or maybe libopenbias-dev)
+
+### Installing required packages on RedHat / Mageia
+
+TODO
+```
+$ rpm ...
+```
+
+### Installing required packages on Fedora
+(it may include some useless packages)
+
+```
+dnf install gcc gcc-c++ automake cmake boost boost-devel SuperLU SuperLU-devel lz4-devel libusb-devel lzo-devel libjpeg-turbo-devel GLEW libGLEW freeglut-devel freeglut SDL2 SDL2-devel freetype-devel libpng-devel qt5-base qt5-qtbase-devel qt5-qtsvg qt5-qtsvg-devel qt5-qtscript qt5-qtscript-devel qt5-qttools qt5-qttools-devel blas blas-devel
+```
+
+### Installing required packages on ArchLinux
+
+```
+$ sudo pacman -S base-devel cmake boost boost-libs qt5-base qt5-svg qt5-script qt5-tools lz4 libusb lzo libjpeg-turbo glew freeglut sdl2 freetype2
+$ sudo pacman -S blas cblas
+```
+From AUR, using eg. yaourt:
+```
+$ yaourt -S superlu
+```
+
+Notes:
+* ArchLinux had BLAS splitted in blas and cblas
+
+### Installing required packages on openSUSE
+
+```
+zypper in boost-devel cmake gcc-c++ freeglut-devel freetype2-devel glew-devel libjpeg-devel liblz4-devel libqt5-linguist-devel libQt5OpenGL5 libqt5-qtbase-devel libqt5-qtscript-devel libqt5-qtsvg-devel lzo-devel libusb-devel openblas-devel SDL2-devel superlu-devel zlib-devel
+```
+
+## Build instructions
+
+### cloning the git tree
+
+```
+$ git clone https://github.com/opentoonz/opentoonz
+```
+
+### Installation of the stuff directory
+
+TODO: some parts should really be installed in $prefix/ instead... and some other in various cache or user-local places.
+cf. https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
+Until then we just follow the Win32/OSX layout.
+
+It is supposedly optional but some files are actually required to run the executable properly.
+
+The .config/OpenToonz/ directory in your home folder will contain your settings, work and other files. We need to create it from the command-line:
+
+```
+$ mkdir -p $HOME/.config/OpenToonz
+$ cp -r opentoonz/stuff $HOME/.config/OpenToonz/
+```
+
+### Creating a default ini file for stuff folders
+
+TODO: fix the code to discover it automatically
+
+```
+$ cat << EOF > $HOME/.config/OpenToonz/SystemVar.ini
+[General]
+OPENTOONZROOT="$HOME/.config/OpenToonz/stuff"
+OpenToonzPROFILES="$HOME/.config/OpenToonz/stuff/profiles"
+TOONZCACHEROOT="$HOME/.config/OpenToonz/stuff/cache"
+TOONZCONFIG="$HOME/.config/OpenToonz/stuff/config"
+TOONZFXPRESETS="$HOME/.config/OpenToonz/stuff/projects/fxs"
+TOONZLIBRARY="$HOME/.config/OpenToonz/stuff/projects/library"
+TOONZPROFILES="$HOME/.config/OpenToonz/stuff/profiles"
+TOONZPROJECTS="$HOME/.config/OpenToonz/stuff/projects"
+TOONZROOT="$HOME/.config/OpenToonz/stuff"
+TOONZSTUDIOPALETTE="$HOME/.config/OpenToonz/stuff/projects/studiopalette"
+EOF
+```
+Note the generated file must not actually contain "$HOME", this shell command repaces it with /home/youraccount in the generated file.
+
+### Building the tiff library from thirdparty
+
+TODO: make sure we can use the system libtiff instead and remove this section.
+Features from the modified libtiff and needed currently, so this isn't a simple switch.
+
+```
+$ cd opentoonz/thirdparty/tiff-4.0.3
+$ CFLAGS="-fPIC" ./configure && make
+$ cd -
+```
+
+### Compiling the actual application
+
+```
+$ cd ../../toonz
+$ mkdir build
+$ cd build
+$ cmake ../sources
+$ make
+```
+
+The build takes a lot of time, be patient.
+
+### Debugging the build
+
+If something doesn't compile or link, please run `make` this way to help spot the problem:
+```
+LANG=C make VERBOSE=1
+```
+
+#### Debug build
+If you need to debug the application, you should be able to use `cmake -DCMAKE_BUILD_TYPE=Debug`.
+
+
+### Running the application
+
+You can now run the application:
+
+```
+$ cd bin
+$ LD_LIBRARY_PATH=image:toonzlib:toonzfarm/tfarm:tnzbase:tnztools:stdfx:sound:tnzcore:tnzext:colorfx:toonzqt toonz/OpenToonz_1.0
+```
+