Browse Source

Update documentation

Former-commit-id: 0b423ad63f33a4939572f1032367cdf271358e02
master
Nils 4 years ago
parent
commit
d7fceffb5c
  1. 1
      CHANGELOG
  2. 22
      README.md
  3. 22
      index.html

1
CHANGELOG

@ -5,6 +5,7 @@ Now compatible with Fluidsynth version 2 (and still with version 1)
Git repository is now public as https://laborejo.org/patroneo.git . Reflect that in the documentation/readme.
DejaVu Sans Sarif is now the default font and therefore a depency.
More reliable Qt settings.
The --mute switch now works when running without installation and without a global calfbox module.
2019-01-15 Version 1.1
Entire program is now based on a common Laborejo-Software-Suite shared program template.

22
README.md

@ -44,7 +44,7 @@ If you want to update at a later date you must use
* Glibc
* Python 3.6 (maybe earlier)
* PyQt5 for Python 3
* DejaVu Sans Sarif TTF (Font)
* DejaVu Sans Sarif TTF (Font) (recommended, but not technically necessary)
* Fluidsynth
#### Build Dependencies
@ -73,13 +73,14 @@ It should appear with an icon in the list and open its GUI.
Starting Fluajho through the Non Session Manager is possible without building or installation.
So you don't need to call the steps above (configure, make, make install)
The developer uses this way to develop the software, so it will always be stable and supported.
But it is a bit less performant than building and installing it.
The developer uses this way to develop and use the software, so it will always be as stable as the
compiled version. But it is a bit less performant than building and installing it.
After extracting the release archive create a symlink from `fluajho` into your PATH. e.g. /usr/bin
or ~/bin, if that exists on your system.
This mode needs calfbox to be installed systemwide. Please consult https://github.com/kfoltman/calfbox
This mode needs calfbox to be installed systemwide (or the --mute switch).
Please consult https://github.com/kfoltman/calfbox
## Starting without Non Session Manager
You need to start fluajho from a terminal (or create a starter script).
@ -100,3 +101,16 @@ prompt to save changes.
It is possible to set /dev/null as save path, or any other nonsense path. The program will start but
you won't be able to save.
## Without NSM, no install or PATH, without calfbox/sound
Combining the above options you can start the program directly after unpacking or cloning from git:
`./fluajho --save /tmp --mute`
Or even shorter:
`./patroneo -s /tmp -m`
This is the minimal run mode which is only useful for testing and development. But if you only want
to look at the GUI and are not in the mood to install anything -including dependencies-, go ahead.

22
index.html

@ -62,7 +62,7 @@ Download the latest code release on <a href="https://www.laborejo.org/downloads"
<li>Glibc</li>
<li>Python 3.6 (maybe earlier)</li>
<li>PyQt5 for Python 3</li>
<li>DejaVu Sans Sarif TTF (Font)</li>
<li>DejaVu Sans Sarif TTF (Font) (recommended, but not technically necessary)</li>
<li>Fluidsynth</li>
</ul>
@ -103,13 +103,14 @@ It should appear with an icon in the list and open its GUI.</p>
<p>Starting Fluajho through the Non Session Manager is possible without building or installation.
So you don&rsquo;t need to call the steps above (configure, make, make install)</p>
<p>The developer uses this way to develop the software, so it will always be stable and supported.
But it is a bit less performant than building and installing it.</p>
<p>The developer uses this way to develop and use the software, so it will always be as stable as the
compiled version. But it is a bit less performant than building and installing it.</p>
<p>After extracting the release archive create a symlink from <code>fluajho</code> into your PATH. e.g. /usr/bin
or ~/bin, if that exists on your system.</p>
<p>This mode needs calfbox to be installed systemwide. Please consult <a href="https://github.com/kfoltman/calfbox">https://github.com/kfoltman/calfbox</a></p>
<p>This mode needs calfbox to be installed systemwide (or the &ndash;mute switch).
Please consult <a href="https://github.com/kfoltman/calfbox">https://github.com/kfoltman/calfbox</a></p>
<h2>Starting without Non Session Manager</h2>
@ -132,6 +133,19 @@ prompt to save changes.</p>
<p>It is possible to set /dev/null as save path, or any other nonsense path. The program will start but
you won&rsquo;t be able to save.</p>
<h2>Without NSM, no install or PATH, without calfbox/sound</h2>
<p>Combining the above options you can start the program directly after unpacking or cloning from git:</p>
<p><code>./fluajho --save /tmp --mute</code></p>
<p>Or even shorter:</p>
<p><code>./patroneo -s /tmp -m</code></p>
<p>This is the minimal run mode which is only useful for testing and development. But if you only want
to look at the GUI and are not in the mood to install anything -including dependencies-, go ahead.</p>
</body>
</html>

Loading…
Cancel
Save