johan / knotter Goto Github PK

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.


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/


Contacts
---------------------------------------
Mattia Basaglia <[email protected]>
Mattia Basaglia (Knotter-specific address) <[email protected]>
[Knotter Website](http://www.knotdraw.org/)
[Knotter Forum](http://www.knotdraw.org/forum/)

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.

By default knotter is configured to load resources from locations in the
filesystem, to generate a single stand-alone file containing all the data
pass the --single-file option to the configuration script

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 build targets
---------------------------------------

desktop_file
:    Generate knotter.desktop

dist
:    Generate source tarball

doc
:    Generate user manual and man page

src_doc
:    Generate Doxygen documentation from the source files


Misc scripts
---------------------------------------

configure.sh
:    Generate Makefile

deb_builder.sh
:    Generate a deb package

doc_builder
:    Same as make doc

fix_makefile.sh
:    Fixes bugs in the Makefile generated by qmake, this is called by configure.sh

info_preprocessor.sh
:    Translates placeholders with the values generated by configure.sh

rpm_builder.sh
:    Generate rpm packages