KLAVAR ! Code
Status: Abandoned
Brought to you by:
cchonig
Menu
▾
▴
Tree [r129] / History
Read Me
<HTML><HEAD><TITLE>KLAVAR ! Readme</TITLE> <BODY> <H1>KLAVAR ! Readme </H1> <P>KLAVAR !<BR>Release date: 2011-01-10 </P> <H2>Table of contents </H2> <UL> <LI><A href="#Overview">Overview</A> <LI><A href="#Installation">Installation</A> <LI><A href="#Compilation">Compilation</A> <LI><A href="#Bugs Report">Bugs</A> <LI><A href="#Updates">Updates</A> <LI><A href="#Copyright">Copyright and Licensing</A> <LI><A href="#Acknowledgements">Acknowledgements</A> </LI></UL> <H2><A name=Overview></A>Overview </H2> <P>KLAVAR! is the porting to MS Windows, Apple Mac OS X and Linux of a graphic music sequencer/notation program based on the easy-to-read KLAVAR music notation: no flats, no sharps, only notes and pauses. It was originally written in GFA Basic for the Atari ST and that version is also available on the project website.<P> <P>Due to lack of hardware resources, it is with regret that, from version 0.9.2, we have to announce the discontinuing of the support for Apple MAC OS and GNU/Linux. Of course the previous versions of the software are still available in the Sourceforge repository.</P> <H2><A name=Installation></A>Installation </H2> <P>First uninstall any previous versions of KLAVAR !. </P> <P>KLAVAR! comes as a self-contained package, thus uninstalling it it's as easy as deleting the folder where the downloaded package had been extracted (on Windows and Linux), or delete the application package (on Apple Mac OS X)</P> <H3>Win32</H3> <P>The application has been originally developed on Microsoft Windows XP.</P> <P>However, from version 0.9.3, only Windows 7 and 8 are supported.</P> <UL> <LI>Extract the package into a folder of your preference.</LI> <LI>Locate the KlavarGuide.pdf file in the directory. This is the latest version of the manual. You will need a PDF reader like Adobe Acrobat Reader to read it.</LI> <LI>To start the application double click on the file klavar.exe</LI> </UL> <H3>MAC OS X (discontinued from 0.9.2)</H3> <P>The application has been developed on MAC OS X 10.6 (Snow Leopard). It is available only for computers with Intel processors.</P> <P>Open the downloaded disk image and copy the program in the system Application folder (the installer must be an administrator).</P> <H3>Linux (discontinued from 0.9.2)</H3> <P>The application has been developed on OpenSuse 11.3 and tested on LinuxMint 10 too.</P> <P>No binary packages are available at the moment. The application must be compiled from source code.</P> <H2><A name=Compilation></A>Compilation </H2> <P>Source code for KLAVAR! can be obtained in two ways</P> <UL> <LI>From the SVN repository (available from SourceForge entering the following SVN command, without quotes "svn co https://klavar.svn.sourceforge.net/svnroot/klavar klavar")</LI> <LI>From the official releases of the development package available at <A href="http://sourceforge.net/projects/klavar/files/"> http://sourceforge.net/projects/klavar/files</A>. Development packages have their names ending with "_dev". They are compressed as zip files. Extracting them would create a folder called "klavar". </LI> </UL> <P>Regardless of the way it is obtained and the platform, the result should be a folder named "klavar" with the development files it.</P> <P><B>IMPORTANT: The version in SVN is a snaphot of the current status of development. It may resemble the official release, but is not even guaranteed to compile. Although we put all our effort in making the code in SVN a version for enthusiasts to download and work with, we stress the fact that it is just a repository of the source code currently in development. That is just our working repository, possibly containing experimental code, not suitable for general use.In other words, you are welcome to download it, but USE AT YOUR OWN RISK.</B> </P> <P>As stated before, the development of KLAVAR! is done around the cross-platform QT Libraries from Nokia. This means that expertise with that development tool is essential. A training session on that package is far beyond the scope of this document. Help on the subject can be found at <A href="http://www.qt-project.org">http://ttp://www.qt-project.org</A> and on a countless number of resources on- and off-line.</P> <H3>Win32</H3> <H4>What Is Needed</H4> <UL> <LI>Qt libraries Open Source version from <A href="http://www.qt-project.org">http://www.qt-project.org</A> for MS Windows. The application can be compiled with the MinGW compiler included in the distribution. The libraries come in several packages for each platform and it is not always easy to find the exact tool needed. If you start from scratch, probably your best way is to download the QT SDK for your platform (or however Digia calls that nowadays), where everything you need is included. However, experienced QT programmers are expected to be able to find their way. Please keep in mind that <B>KLAVAR! is not a project for beginners.</B></LI> </UL> <P>The expanded folder from the development package contains a klavar.pro file. If you are experienced in managing QT project it shouldn't be difficult to understand the configuration.</P> <P>If the project is managed with Qt Creator (at least release 2.6.0), opening klavar.pro in the IDE will create the possibility to write software for the project, compile and run it.</P> <H3>MAC OS X(discontinued from 0.9.2)</H3> <H4>What Is Needed</H4> <UL> <LI>An Apple computer with Intel processor and MAC OS X Snow Leopard. A development environment, including Xcode, must be present. We can give support on how to compile with Xcode.</LI> <LI>Qt libraries Open Source version from <A href="http://qt.nokia.com">http://qt.nokia.com</A> for MAC OS X. We have developed the application on OS X using Xcode. The libraries come in several packages for each platform and it is not always easy to find the exact tool needed. In our environment we only needed the "Cocoa: Mac binary package for Mac OS X 10.5 - 10.6 (32-bit and 64-bit)" currently available at <A href="http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x">http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x</A>. Please keep in mind that <B>KLAVAR! is not a project for beginners.</B></LI> </UL> <P>The expanded folder from the development package contains a klavar.pro file. Open a terminal window and go to the folder containing the file. Run the command qmake and, provided that the QT environment is set up correctly, a project file for Xcode is generated. Open the generated file as a project in Xcode and you should be ready to go.</P> <H3>Linux(discontinued from 0.9.2)</H3> <H4>What Is Needed</H4> <UL> <LI>A computer with Intel processor and a reasonably up-to-date Linux distribution and that means a distribution where Nokia QT libraries with a version > 4.5.0 are available or where the latest version of the Nokia QT SDK can be installed. That means almost any current major distribution.</LI> <LI>The development package of the fluidsynth libraries for your distribution.</LI> <LI>Please keep in mind that <B>KLAVAR! is not a project for beginners.</B></LI> </UL> <P>The expanded folder from the development package contains a klavar.pro file. This is the file that contains the definition of the development environment for the project. Experienced QT programmer shouldn't have any problem in finding their way around.</P> <P></P> <H2><A name=Bugs></A>Bugs </H2> <P>Please search our online forum <A href="http://sourceforge.net/projects/klavar/forums/forum/947516">http://sourceforge.net/projects/klavar/forums/forum/947516</A></P> <P>Should you not be able to find the solution to your problem, please contact one of the Project Administrators</P> <H2><A name=Updates></A>Updates </H2> <P>A World Wide Web home page for KLAVAR ! is at <A href="http://www.klavarscore.co.uk">http://www.klavarscore.co.uk</A></P> <P>The latest version of KLAVAR ! for the different platforms is available from <A href="http://sourceforge.net/projects/klavar">http://sourceforge.net/projects/klavar</A> </P> <H2><A name=Copyright></A>Copyright and Licensing</H2> <P>KLAVAR ! is copyright by Claes Honig.<BR> KLAVAR ! is distributed under the GNU Public Licence. The text licence is contained in the file COPYING, which you should have received with the package. If not, a good place where to look is <A href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</A> <H2><A name=Acknowledgements></A>Acknowledgements </H2> <P>Claes Honig (SourceForge ID: cchonig), for the decision to release the application as open source.</P> <P>Marco Mascioli (SourceForge ID: methos2004) for porting the application to Microsoft Windows, MAC OS X and Linux.</P> <P>Gary P. Scavone for the RTMidi library</P>
