Commit 148c603a authored by SeeLook's avatar SeeLook 🎸
Browse files

Use markdown for README, update content

parent 24f97bd3
888b 88 88
8888b 88 ,d 88
88 `8b 88 88 88
88 `8b 88 ,adPPYba, ,adPPYba, MM88MMM 88 ,d8 ,adPPYYba,
88 `8b 88 a8" "8a a8" "8a 88 88 ,a8" "" `Y8
88 `8b 88 8b d8 8b d8 88 8888[ ,adPPPPP88
88 `8888 "8a, ,a8" "8a, ,a8" 88, 88`"Yba, 88, ,88
88 `888 `"YbbdP"' `"YbbdP"' "Y888 88 `Y8a `"8bbdP"Y8
... to play scores
Nootka is an application to discover and learn classical score notation.
It helps to understand the rules of reading and writing scores
and helps with developing skills of playing and singing notes from a score.
The application is free and open source.
It works under Windows, Linux, Mac and Android.
BUILD INSTRUCTION
######################################################################################
I... Requirements: #########################
######################################################################################
- c++11 capable compiler (tested with gcc >=4.9 and clang)
- cmake at least version 3.1.0 (http://cmake.org)
- Qt libraries (at least version 5.9)
In particular: Qt5Core, Qt5Gui, Qt5Widgets, Qt5PrintSupport, Qt5Network, Qt5Qml, Qt5QtQuick, Qt5QuickControls2
- Ogg Vorbis (http://www.xiph.org/downloads/)
both ogg and vorbis. Dll libraries are on mentioned site in vorbis-tools archive
and headers are in libogg and libvorbis archives.
Under Linux: libvorbis-dev & libogg-dev (or similar)
- FFTW libraries (http://www.fftw.org/)
Under Linux: libfftw3-dev (or similar)
- under Linux and MacOs only
SoundTouch library (http://www.surina.net/soundtouch/)
(libsoundtouch and libsoundtouch-dev)
- libasound-dev under linux
######################################################################################
II... Building: ########################
######################################################################################
In short:
cmake nootka_sources && make && make install
In details:
1. Unpack Nootka tarball (archive)
2. go into unpacked directory
3. create some directory (i.e. 'build')
4. go into created dir (i.e. cd build)
---------------------------------------------------------------------------------------------------------
5. Launch:
cmake ../
or
ccmake ../
or
launch graphical cmake-gui and select source and build directories there
---------------------------------------------------------------------------------------------------------
if you get error about not found libfftw or libvorbis
put them manually as a cmake launch parameter:
-DFFTW3_LIBRARIES=/path_to/libfftw3f.la(dll)
-DFFTW3_INCLUDE_DIRS=/path_to_dir_with/fftw3.h
-DVORBIS_LIBRARIES =/path_to/libvorbisfile.so(dll)
-DVORBIS_INCLUDE_DIRS=/path_to_dir_with/vorbis/vorbisfile.h
-DOGG_INCLUDE_DIRS=/path_to_dir_with/ogg/ogg.h
also
-DCMAKE_INSTALL_PREFIX=/install/dir to change installation target
-DCMAKE_BUILD_TYPE=debug to build Nootka in debug mode
so you can invoke:
cmake -DCMAKE_INSTALL_PREFIX=/my/special/dir ../
or do the same with GUI
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
NOTE for Windows build:
If you put unpacked archives of fftw and ogg-vorbis in the 'build' directory,
and you remove the versions numbers from their names, to have:
libogg, libvorbis, fftw and vorbis-tools directories,
cmake will find all of them automagically.
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
---------------------------------------------------------------------------------------------------------
- There is an option for building Nootka with online checking for new versions
---------------------------------------------------------------------------------------------------------
- Also under Linux there are options to build Nootka with native support for:
- Jack Audio Connection Kit support (requires libjack-dev)
- PulseAudio (requires libpulse-dev)
When those headers/libs are found - options are selected automatically
but they can be controlled by:
-DENABLE_JACK=OFF -DENABLE_PULSEAUDIO=OFF (OFF or ON)
---------------------------------------------------------------------------------------------------------
6. then call
make
or
make -j[number of CPU cores], f.e.: make -j4
---------------------------------------------------------------------------------------------------------
- If you want to launch Nootka without installing - in a place where it is compiled
call
make runinplace
it will copy or link all necessary stuff next to build executable
then invoke
./src/nootka
or just hit a file called 'nootka'
---------------------------------------------------------------------------------------------------------
7. make install (usually as root)
alternatively you can invoke
make install DESTDIR=/your/Dir
and push the installation wherever you want (similarly to -DCMAKE_INSTALL_PREFIX)
Under Windows call
make deploy
to copy all related libraries and make instalation folder independent
---------------------------------------------------------------------------------------------------------
8. to remove (uninstall)
- make uninstall (usually as root)
+++++++++++++++++++++++++++++ Qt Creator +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Steps from 2 to 8 can be achieved also in Qt Creator - development IDE.
Just open CMakeLists.txt file, placed in main Nootka archive folder and follow the instructions
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!!!!!!!!!!!! GOOD LUCK !!!!!!!!!
############################################################################################################
III... Packaging ##########################################################
############################################################################################################
you can easily generate rpm and deb package and Windows installer.
1. For deb call:
cpack -G DEB
(obviously dependencies for build debian packages are required)
3. To build Windows installer http://nsis.sourceforge.net is necessary.
After installation there is nootka-utf8.nsi file. Launch it in nsis and the installer will be built.
make deploy
has to be called before!
######################################################################################
#### How to prepare development environment under MacOs ##
######################################################################################
1. Install Xcode & X11 (from MacOs install DVD or App Store). XCode SDK is not required
2. Install MacPorts
http://www.macports.org/install.php
and in terminal type:
sudo port install pkgconfig cmake mercurial fftw-3-single libvorbis soundtouch
Alternatively you can use Fink or another MacOs packaging system
3. Download and install QT libraries:
go to
http://qt-project.org/downloads
and take Qt libraries version 5.9 or any above
and install it.
4. Now you can go to to Building section
5. 'make install' under MacOs generates independent bundle with all needed frameworks inside
<img src="picts/logo.png" width="25%" height="25%"/>
... to play scores
============================
<img align="left" width="20%" height="20%" src="picts/hicolor/256x256/apps/nootka.png"/>
[https://nootka.sourceforge.io](https://nootka.sourceforge.io/)
**Nootka** is an application to discover and learn classical score notation.
It helps to understand the rules of reading and writing scores
and helps with developing skills of playing and singing notes from a score.
The application is free and open source.
It works under Windows, Linux, Mac and Android.
### Features
- interactive interface to discover the rules of musical notation
- exercises with possibility to create own sets
- accurate method for detecting sung and played sounds and melodies
- natural sound of instruments
- clefs (treble, bass and others) and grand stave
- analyze of results
- different kinds of guitars and theirs tuning
- piano, bandoneon and saxophones (experimental)
- Czech, French, German, Hungarian, Italian, Polish, Spanish, Slovenian and Russian translations
Download and Installation
--------------------------
Here is [download page](https://nootka.sourceforge.io/index.php/download/)
But **Nootka** is available in installers of many Linux distributions.
Also in [Google Play Store](https://play.google.com/store/apps/details?id=net.sf.nootka)
Compilation from sources
----------------------------
- [actual state](https://nootka.sourceforge.io/index.php/help/#compile-debug)
also in **git master** branch
- [stable version](https://nootka.sourceforge.io/index.php/help/#compilation)
also in **git release** branch
Help
----------------------------
- [Help topics](https://nootka.sourceforge.io/index.php/help)
- [Bug tracker](https://sourceforge.net/p/nootka/bugs/)
- [Feature request](https://sourceforge.net/p/nootka/feature-requests/)
<img src="spare_parts/screen.png"/>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment