Skip to content

Latest commit

 

History

History
100 lines (61 loc) · 4.32 KB

INSTALL.md

File metadata and controls

100 lines (61 loc) · 4.32 KB
Raw

Installation Instructions

Binary installation

Linux

Linux binaries are available from the GitHub repository. We recommend to simply download and run the AppImage version available from the release page. The AppImage version ships with all requirements included so you just need to make the file executable and your ready to go. Keep in mind however that the AppImage doesn't receive any updates so you might have do download newer version manually.
Raw binaries are also available but require you to install qt4 (likely called libqt4) and graphviz (likely called libgraphviz-dev) by yourself. Currently this might be not be possible because qt4 is already deprecated on many Linux distributions.

Windows

Currently pre-compiled binaries are available at the GitHub repository. However you might still need to install QT4 and graphviz yourself. If you know how to build a Windows installer your help would be appreciated a lot.

There exists a (graphical) Windows installer for older versions however that can be downloaded from http://www.sourceforge.net/projects/qfsm. The installation should be straightforward and doesn't require any other software to be installed.

Mac OS X

Binary packages for Mac OS X may be provided by third-party websites, like http://mac.softpedia.com/get/Math-Scientific/Qfms.shtml.

Installing from source code

Qfsm has to be compiled using the CMake buildsystem.

Requirements

See the documentation of these tools/libraries for an explanation how to install them.

Building under GNU Linux/Unix

Install the above-mentioned required software. If you install them via a package manager make sure you install the development packages (...-dev or ...-devel).

On Debian-based systems (like Ubuntu and Linux Mint) you will likely need to install the packages libqt4-dev and libgraphviz-dev.

Unpack the source code into the current directory

unzip qfsm-0.56.0-Source.zip

and change to that directory.

Before invoking CMake you have to make sure that the program qmake is in your global PATH environment variable. On most Linux-distributions this will work automatically but in case is doesn't work simply the following step:
The location of qmake depends on your operating system or Linux distribution. On openSUSE for example it is under: /usr/lib/qt4/bin/ Thus, if you are using bash, you would have to type:

export PATH=/usr/lib/qt4/bin:$PATH

Configure and compile:

cmake .

Then:

make

Finally, install Qfsm (as root):

make install

This will install the executable "qfsm" to /usr/bin/ and the documentation to /usr/share/doc/qfsm/.

If CMake fails to find any of the dependencies but you know you have the development headers/libraries installed, add -DLIBRARY_SEARCH_DIRS=<path/to/lib> and -DINCLUDE_SEARCH_DIRS=<path/to/include> to the cmake command.

If you want to create a project file for your IDE (e.g. KDevelop), add -GKDevelop3 to the cmake command above. This will create a .kdevelop file in the build directory which can be opened by KDevelop.

Building under Windows

In order to build Qfsm under Windows you have to execute the program CMakeSetup, specify input (source) and output directory and click on "Configure". You may choose between different development environments (e.g. Visual Studio) and CMake will create the respective project files. You can then compile Qfsm as usual with your preferred build tool. For more details, refer to the CMake documentation: http://www.cmake.org/HTML/Documentation.html.

Compiling with Graphviz support:

  • download the binary graphviz package from http://www.graphviz.org/Download_windows.php.
  • unpack and copy the contents of the release folder to something like "C:\graphviz"
  • if you copy it to another folder change the paths in graphviz_INCLUDE_DIRS and graphviz_LIBRARY_DIRS in CMakeLists.txt accordingly
  • run cmake
  • compile