Browse Source

Update documentation

master
Nils 4 years ago
parent
commit
1841c4a579
  1. 11
      README.md
  2. 18
      documentation/english.adoc
  3. 33
      documentation/out/english.html
  4. 2
      documentation/out/german.html

11
README.md

@ -1,19 +1,22 @@
#Fluajho
For program version 1.3
Program version 1.3
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the Non Session Manager and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
instruments that can be assigned to 16 MIDI channels. Finally connect external sequencers, such as
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.
Workflow summary: Load an .sf2 file by the file menu or drag and drop. You can then choose one
instrument for each of the 16 MIDI-channels by using the GUI or via midi signals.
Connect external sequencers or midi devices to play the instruments.
This README is just a short introduction. Consult the manual (see below) for more information.

18
documentation/english.adoc

@ -27,17 +27,23 @@ https://asciidoctor.org/docs/user-manual/
// Don't write in the empty line above line. It will be interpreted as author html tag
For program version 1.3
== Usage
== Introduction
We are happy you chose Fluajho. Fluajho is a sampler for sf2 soundfonts. This is a legacy file format for making MIDI signals audible through virtual instruments.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts instruments that can be assigned to 16 MIDI channels.
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.
"Fluajho" (with jh as in pleasure) means fluid in Esperanto. Behind the scenes the "Fluidsynth" software library is at work.
.sf2 is an old file format for making MIDI signals audible through virtual instruments, although it
is still in moderate use today.
=== Purpose and target audience
Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the Non Session Manager and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.
There are many soundfont samplers for Linux, most of them based on fluidsynth. Fluajho was written for a clearly defined use case: Load an .sf2 in the Non Session Manager and save the soundfont in the session directory. This makes it possible to archive the session, for example as a backup or to share it.
You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
instruments that can be assigned to 16 MIDI channels. Finally connect external sequencers, such as
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.
=== Quick Start

33
documentation/out/english.html

@ -445,11 +445,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_usage">1. Usage</a>
<li><a href="#_introduction">1. Introduction</a>
<ul class="sectlevel2">
<li><a href="#_purpose_and_target_audience">1.1. Purpose and target audience</a></li>
<li><a href="#_quick_start">1.2. Quick Start</a></li>
<li><a href="#_basic_principles">1.3. Basic Principles</a></li>
<li><a href="#_quick_start">1.1. Quick Start</a></li>
<li><a href="#_basic_principles">1.2. Basic Principles</a></li>
</ul>
</li>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">2. Description of the graphical user interface and its functions</a></li>
@ -473,25 +472,29 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="sect1">
<h2 id="_usage">1. Usage</h2>
<h2 id="_introduction">1. Introduction</h2>
<div class="sectionbody">
<div class="paragraph">
<p>We are happy you chose Fluajho. Fluajho is a sampler for sf2 soundfonts. This is a legacy file format for making MIDI signals audible through virtual instruments.</p>
<p>"Fluajho" (with jh as in pleasure) means fluid in Esperanto. It is a simple sf2 soundfont
host/player for Linux. Behind the scenes the Fluidsynth library is at work, hence the name.</p>
</div>
<div class="paragraph">
<p>You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts instruments that can be assigned to 16 MIDI channels.</p>
<div class="title">sf2 is an old file format for making MIDI signals audible through virtual instruments, although it</div>
<p>is still in moderate use today.</p>
</div>
<div class="paragraph">
<p>"Fluajho" (with jh as in pleasure) means fluid in Esperanto. Behind the scenes the "Fluidsynth" software library is at work.</p>
<p>Why does Fluajho exist? There are many soundfont players for Linux,
most of them even based on Fluidsynth. Fluajho was written for a clearly defined use case:
Load an .sf2 in the Non Session Manager and save the soundfont in the session directory.
This makes it possible to archive the session, for example as a backup or to share it.</p>
</div>
<div class="sect2">
<h3 id="_purpose_and_target_audience">1.1. Purpose and target audience</h3>
<div class="paragraph">
<p>There are many soundfont samplers for Linux, most of them based on fluidsynth. Fluajho was written for a clearly defined use case: Load an .sf2 in the Non Session Manager and save the soundfont in the session directory. This makes it possible to archive the session, for example as a backup or to share it.</p>
</div>
<p>You can load one soundfont file per Fluajho instance. Each instance holds 16 of the soundfonts
instruments that can be assigned to 16 MIDI channels. Finally connect external sequencers, such as
Laborejo, Patroneo or Vico, through JACK-Midi to play the instruments.</p>
</div>
<div class="sect2">
<h3 id="_quick_start">1.2. Quick Start</h3>
<h3 id="_quick_start">1.1. Quick Start</h3>
<div class="paragraph">
<p>To get to know the most important functions and workflows, this video has been created.</p>
</div>
@ -512,7 +515,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_basic_principles">1.3. Basic Principles</h3>
<h3 id="_basic_principles">1.2. Basic Principles</h3>
<div class="paragraph">
<p>Fluajho loads exactly one <code>.sf2</code> soundfont. A soundfont can contain several instruments, of which up to 16 can be used simultaneously.</p>
</div>
@ -804,7 +807,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-10-03 11:41:27 +0200
Last updated 2019-10-04 23:57:50 +0200
</div>
</div>
</body>

2
documentation/out/german.html

@ -812,7 +812,7 @@ Ansonsten starten Sie fluajho mit diesem Befehl, Sprachcode ändern, vom Termina
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-10-03 11:41:27 +0200
Last updated 2019-10-04 23:57:50 +0200
</div>
</div>
</body>

Loading…
Cancel
Save