Skip to content

Commit

Permalink
Merging development to master
Browse files Browse the repository at this point in the history
  • Loading branch information
hbitteur committed Jun 28, 2023
2 parents 16aa23a + 22f6b6d commit 0eabc04
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 68 deletions.
58 changes: 14 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,64 +32,34 @@ Audiveris comes with an integrated exporter to write (a subset of) this OMR data
[MusicXML][musicxml] 4.0 format.
In the future, other exporters are expected to build upon OMR data to support other target formats.

## Installing binaries (Windows)
## Installation

On GitHub [Releases][releases] page, an Audiveris installer is available for Windows.
- For **Windows** only, an installer is provided.
- For **Windows**, **MacOS**, **Linux** and **ArchLinux**, you can download and build from sources:
- Either from default "*master*" branch,
- Or, preferably, from "*development*" branch.
See details in the dedicated [Wiki article][workflow].

It takes care of the whole installation, including needed libraries like Tesseract OCR,
but assumes that you already have a suitable Java installed.
Audiveris 5.3 requires Java version 17
Using the installer or building from sources, in both cases you will need two additional
components:
1. Java environment (Java 17 minimum)
2. Tesseract language files (for version 4 and up)

You can download them from [Oracle JDKs download site][jdk-downloads].

And since Oracle provides Java 11 and above only for 64-bit architectures, the same restriction
applies to Audiveris as well.
Should you really need a 32-bit Audiveris version, you can still use old Audiveris 5.1 version
from the [Releases][releases] page.

For further installation details, please refer to HandBook [Binaries][binaries] section.

## Building from sources (Windows, MacOS and Linux)

**NOTA** for GitHub users:
- Audiveris "*master*" branch is updated only when a new release is published.
- Instead, Audiveris development happens continuously in "*development*" branch, so checkout and pull
this *development* branch to get and build the latest version.
- See workflow details in this dedicated [Wiki article][workflow].

You will need the typical tools: git, gradle and Java Development Kit (JDK).

All libraries, including Tesseract OCR libraries, will get pulled as Gradle dependencies
but you will have to download Tesseract language data files.

And we have to make it clear, because the same issues are posted again and again:
1. Audiveris 5.3 now uses Tesseract 5.x.
2. No Tesseract executable needs to be installed, since Tesseract is used via **libraries**.
3. You can have other Tesseract versions installed, they will not impede Audiveris behavior,
provided that Audiveris can find its needed Tesseract language files
(typically via **TESSDATA_PREFIX** environment variable).
4. Tesseract language files, can be downloaded from [Tesseract download site][lang-downloads].
Pickup the recent versions compatible with Tesseract 4 and above, not the old 3.x versions.

For further building details, please refer to HandBook [Sources][sources] section.
Please read further information in [HandBook installation][installation] section.

## Further Information

Users and Developers are advised to read the specific [User Handbook][handbook],
Users and Developers are advised to read Audiveris [User Handbook][handbook],
and the more general [Wiki][audiveris-wiki] set of articles.

## Releases

All releases are available on [Audiveris Releases][releases] page.

[audiveris-eg]: htps://github.com/Audiveris/audiveris-eg
[audiveris-wiki]: https://github.com/Audiveris/audiveris/wiki
[binaries]: https://audiveris.github.io/audiveris/_pages/install/binaries/
[handbook]: https://audiveris.github.io/audiveris/_pages/index-5.2/
[handbook]: https://audiveris.github.io/audiveris/
[imslp]: https://imslp.org/
[jdk-downloads]: https://www.oracle.com/java/technologies/downloads/
[lang-downloads]: https://github.com/tesseract-ocr/tessdata
[installation]: https://audiveris.github.io/audiveris/_pages/install/README/
[musicxml]: http://www.musicxml.com/
[releases]: https://github.com/Audiveris/audiveris/releases
[sources]: https://audiveris.github.io/audiveris/_pages/install/sources/
[workflow]: https://github.com/Audiveris/audiveris/wiki/Git-Workflow
33 changes: 20 additions & 13 deletions docs/_pages/handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ has_toc: false
# Audiveris Handbook
{: .no_toc }

This documentation applies to release 5.2 and later.
This documentation applies to release {{ site.audiveris_version }} and later.

---
Table of contents
Expand All @@ -25,30 +25,36 @@ To ease the reading for a new comer as for a more advanced user, it is organized
as a progressive sequence of chapters.

It is just a user manual, a true developer documentation is still to be written.
Some material is already made available through
Audiveris [Wiki](https://github.com/Audiveris/audiveris/wiki) to ease the software learning
curve for any potential developer.
Some material is already made available, through
Audiveris [Wiki](https://github.com/Audiveris/audiveris/wiki)
and through the description of [.omr file format](./outputs/omr.md), to ease the software
learning curve for any potential developer.

## Overview

When questioned about Audiveris, ChatGPT answered:
> Audiveris is an open source Optical Music Recognition (OMR) software. It is used to scan sheet music and convert it into a machine-readable format, such as MusicXML or MIDI. This allows the music to be edited, played back, and shared digitally.
Not that bad! But let's try to describe it on our own...

Audiveris is an open source software, published under the
[AGPL](https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License) V3 license.

It is an **O**ptical **M**usic **R**ecognition (OMR) application,
featuring an OMR engine coupled with a dedicated editor.
featuring an OMR engine coupled with an interactive editor.

It recognizes music from digitized images and converts it into
computer-readable symbolic format.
This enables further music processing by any external notation editor,
most notably: digital playback, transposition and arrangement.
notably: digital playback, transposition and arrangement.

Audiveris provides outputs in two main digital formats: its OMR format and
Audiveris provides outputs in two main digital formats: its own OMR format and the
standard MusicXML format.
* [OMR](https://github.com/Audiveris/audiveris/wiki/Project-Structure) is the
Audiveris specific format, a documented open source format based on XML.
* [MusicXML](http://usermanuals.musicxml.com/MusicXML/MusicXML.htm) has been
designed for score interchange and is supported as input/output by almost every
music notation program today.
* [MusicXML](http://usermanuals.musicxml.com/MusicXML/MusicXML.htm) is a *de facto* standard.
Is has been designed for score interchange and is today
supported as input/output by almost every music notation program.

Not any kind of sheet music can be handled. Audiveris engine has been designed
to process scores written in the _Common Western Music Notation_ (CWMN)
Expand All @@ -60,9 +66,10 @@ Because the accuracy of OMR engine is still far from perfection,
Audiveris application provides a graphical user interface specifically focused
on quick verification and manual correction of the OMR outputs.

More sophisticated music editors, such as MuseScore or Finale, can be used on
External sophisticated music editors, such as MuseScore or Finale, can be used on
Audiveris MusicXML output.
They can even be directly connected via simple [plugins](/advanced/plugins.md).
They can even be directly connected via simple [plugins](./advanced/plugins.md)
to ease data transfer from Audiveris to these external editors.

## Handbook content

Expand All @@ -79,7 +86,7 @@ Thorough description of software main features.
Main tools and typical examples to correct OMR outputs.

1. [Specific features](./specific/README.md):
Specific features just introduced.
Specific features recently added to Audiveris.

1. [Advanced features](./advanced/README.md):
Features only relevant for an advanced usage of Audiveris.
Expand Down
10 changes: 8 additions & 2 deletions docs/_pages/install/sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ title: Building from sources
nav_order: 4
parent: Installation
---
## Building from sources (Windows, Linux, MacOS)
## Building from sources (Windows, MacOS, Linux, ArchLinux)
{: .no_toc }

TBD development vs master branches
{: .note }
For GitHub users:
- Audiveris "*master*" branch is updated only when a new release is published.
- Instead, Audiveris development happens continuously in "*development*" branch, so checkout and pull
this *development* branch to get and build the latest version.
- See workflow details in this dedicated [Wiki article][workflow].

Table of contents
{: .no_toc .text-delta }
Expand Down Expand Up @@ -117,3 +122,4 @@ java -cp "Audiveris/lib/*" Audiveris
[git]: https://git-scm.com
[gradle]: https://gradle.org
[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
[workflow]: https://github.com/Audiveris/audiveris/wiki/Git-Workflow
9 changes: 0 additions & 9 deletions docs/_pages/ui_tools/inter_editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,6 @@ Multiple-line editor:

See details in [Octave Shift section](../specific/octave_shift.md#edition)

### Octave shift editor

![](../assets/images/octave_shift_edited.png)

These are the 3 handles available for a simple octave shift.

But more complex actions are possible.
Please refer to the dedicated [Octave shift Edition](octave_shift.md#edition) section.

### Slur editor
![](../assets/images/slur_edited.png)

Expand Down

0 comments on commit 0eabc04

Please sign in to comment.