File	Date	Author	Commit
data	2013-11-19	Mattia Basaglia	[8114c0] Merge branch 'OSX_fix'
man	2013-11-19	Mattia Basaglia	[8114c0] Merge branch 'OSX_fix'
package	2013-11-19	Mattia Basaglia	[8114c0] Merge branch 'OSX_fix'
src	2013-12-17	Mattia Basaglia	[2c4f55] Fix Qt compile checks
.gitignore	2013-10-21	Mattia Basaglia	[b7d20c] Merge branch 'scripted_edges'
.gitmodules	2013-05-31	Mattia Basaglia	[872270] History line edit
.travis.yml	2013-02-13	Mattia Basaglia	[3dbf34] Merge branch 'scripting'
AUTHORS	2013-10-18	Mattia Basaglia	[0f1e2c] Update translations
COPYING	2012-08-15	Mattia Basaglia	[82baac] Initial commit
Doxyfile.in	2013-10-14	Mattia Basaglia	[b068c8] Fix Doxygen icon
README	2013-05-14	Mattia Basaglia	[f34799] Fix README
configure.sh	2013-11-26	Mattia Basaglia	[dcb8da] Merge branch 'master' of github.com:mbasaglia/K...
fix_makefile.sh	2013-05-15	Mattia Basaglia	[1e25f0] Toggle Toolbar preferences
info_preprocessor.sh	2013-05-29	Mattia Basaglia	[19a501] Auto-enable plugins
knotter.desktop.in	2012-09-13	Mattia Basaglia	[35d9f7] Misc script fixes
knotter.pro	2013-12-17	Mattia Basaglia	[2c4f55] Fix Qt compile checks
knotter_info.pri	2013-11-26	Mattia Basaglia	[dcb8da] Merge branch 'master' of github.com:mbasaglia/K...
pull.sh	2013-06-06	Mattia Basaglia	[787a69] Pull helper script
translations.pri	2013-10-18	Mattia Basaglia	[0f1e2c] Update translations
windows.rc	2013-06-06	Mattia Basaglia	[612e70] Fix windows icon

Read Me

Kotter
=======================================

About
---------------------------------------
This program is a designer for Celtic knotworks, using the mathematical
correlation between knots and graphs.

The software is under development, some features may change without
notice and there may be some bugs.


Contacts
---------------------------------------
Mattia Basaglia <mattia.basaglia@gmail.com>
[Knotter Website](http://knotter.mattbas.org/)

If you have any suggestion, criticism, feature request or bug report please let me know


License
---------------------------------------
GPLv3 or later, see COPYING.


Build instructions
---------------------------------------

Quick build

    ./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)


Dependencies
---------------------------------------

* Qt Framework, should work with 4.8 or later

Misc build targets
---------------------------------------

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


Getting the latest sources
---------------------------------------

The git repository is located at git://github.com/mbasaglia/Knotter.git
You can browse it online at https://github.com/mbasaglia/Knotter

Some tarballs can be downloaded from https://sourceforge.net/projects/knotter/files/


### 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