Difference between revisions of "Building from source"

From Knotter
Jump to navigation Jump to search
(Created page with " ==Build instructions== ===Dependencies=== * [http://qt-project.org Qt Framework], should work with versions 4.8 and 5.0 ===From a shell=== ./configure.sh && make The...")
 
Line 8: Line 8:
 
===From a shell===
 
===From a shell===
  
 +
<source lang="bash">
 
     ./configure.sh && make
 
     ./configure.sh && make
 +
</source>
  
 
The configuration script will generate the makefile using qmake and set up
 
The configuration script will generate the makefile using qmake and set up
 
the installation directories, for more information run
 
the installation directories, for more information run
  
 +
<source lang="bash">
 
     ./configure.sh --help
 
     ./configure.sh --help
 +
</source>
  
 
If the configure script fails despite being in a proper build environment you
 
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
+
can run directly qmake on knotter.pro. Be advised that this will make some
 
make targets buggy or unavailable.
 
make targets buggy or unavailable.
  
 
If you want to regenerate the files created by the Qt build tools, run
 
If you want to regenerate the files created by the Qt build tools, run
  
 +
<source lang="bash">
 
     make clean
 
     make clean
 
     make
 
     make
 +
</source>
  
 
To install the binaries run
 
To install the binaries run
  
 +
<source lang="bash">
 
     make install
 
     make install
 +
</source>
  
 
To install in a specific directory, you can set INSTALL_ROOT
 
To install in a specific directory, you can set INSTALL_ROOT
  
 +
<source lang="bash">
 
     make install INSTALL_ROOT=/some/directory
 
     make install INSTALL_ROOT=/some/directory
 +
</source>
  
 
The default install prefix is /usr/local (see ./configure.sh --help)
 
The default install prefix is /usr/local (see ./configure.sh --help)
Line 56: Line 66:
 
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 coloned:
 +
<source lang="bash">
 +
#Clone repo
 +
git clone git://github.com/mbasaglia/Knotter.git
  
    # Clone repo
+
# Initialize submodules
    git clone git://github.com/mbasaglia/Knotter.git
+
git submodule init
  
    # Initialize submodules
+
# Clone submodules
    git submodule init
+
git submodule update
 
+
</source>
    # Clone submodules
 
    git submodule update
 

Revision as of 21:45, 8 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 coloned:

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

# Initialize submodules
git submodule init

# Clone submodules
git submodule update