Difference between revisions of "Building from source"

From Knotter
Jump to navigation Jump to search
Line 4: Line 4:
 
===Dependencies===
 
===Dependencies===
  
* [http://qt-project.org Qt Framework], should work with versions 4.8 and 5.0
+
* [http://qt-project.org Qt Framework], should work with 4.8 or later
  
 
===From a shell===
 
===From a shell===
Line 65: Line 65:
  
 
This source tree uses git submodules, this means that the submodules need to
 
This source tree uses git submodules, this means that the submodules need to
be initialized when the repo is coloned:
+
be initialized when the repo is cloned:
 
<source lang="bash">
 
<source lang="bash">
 
#Clone repo
 
#Clone repo

Revision as of 10:49, 14 May 2013

Build instructions

Dependencies

From a shell

    ./configure.sh && make

The configuration script will generate the makefile using qmake and set up the installation directories, for more information run

    ./configure.sh --help

If the configure script fails despite being in a proper build environment you can run directly qmake on knotter.pro. Be advised that this will make some make targets buggy or unavailable.

If you want to regenerate the files created by the Qt build tools, run

    make clean
    make

To install the binaries run

    make install

To install in a specific directory, you can set INSTALL_ROOT

    make install INSTALL_ROOT=/some/directory

The default install prefix is /usr/local (see ./configure.sh --help)

Misc make targets

dist
Generate source tarball
src_doc
Generate Doxygen documentation from the source files

From Qt Creator

Open knotter.pro and click Build (Ctrl+B) to compile and Run (Ctrl+R) to start Knotter.

Getting the latest sources


Cloning from Git

This source tree uses git submodules, this means that the submodules need to be initialized when the repo is cloned:

#Clone repo
git clone git://github.com/mbasaglia/Knotter.git

# Initialize submodules
git submodule init

# Clone submodules
git submodule update