Building - grame-cncm/inscore GitHub Wiki

Compiling the INScore project

Prerequisites

  • you must have Qt version 5.11 or later installed
  • you must have cmake version 3.6.0 or greater installed.
  • you must have libmicrohttpd installed.

The present document describes how to compile the INScore project.


Compiling

The INScore build system relies on 'make' and cmake The 'build' folder contains a 'Makefile' that call 'cmake' to generate the native projects and to compile in 'release' mode.

To compile:

    > cd build
    > make

and that's all !!

Want to get more control over the build process?

    > make help

Of course, if you are comfortable with 'cmake', you can always directly call 'cmake' commands.

Warning

Don't run the 'cmake' commands from the 'build' folder, it'll overwrite the Makefile. In case you do so, you can restore the Makefile using

    > git checkout Makefile

Note for Windows

On Windows, a specific script named 'Make.bat' provides services roughly equivalent to the 'Makefile'. Just replace 'make' with 'make.bat' on the above instructions.

INScore external modules

The INScore project depends on external libraries:

  • the GuidoEngine library: included as submodule
  • the GuidoAR library: included as submodule
  • the MusicXML library: included as submodule
  • the oscpack library (included in the INScore repository)

Note that MusicXML support makes use of dynamic link: it is available only when a library with the required entry point is found.

Note about the Guido Font


INScore is distributed as a standalone application and should work as is. However, depending on your platform and on your operating system version, it may fail to load the music font correctly. The symptom is strange glyphs when you display symbolic music notation. To solve the problem, you have to install the font manually:

  • the music font file is guido2.ttf, it is located along the application
  • to install double click the guido2.ttf file. On most of the systems, a font manager will open that contains an install button.

Note also that to update an existing font file, it is safer to uninstall the previous version before installing the new one.


In case of trouble, contact me: [email protected]