diff --git a/README.md b/README.md index c6fbf93..19335c1 100644 --- a/README.md +++ b/README.md @@ -60,27 +60,24 @@ If you want to update at a later date you must use make sudo make install -## Starting through the Non Session Manager after installation (recommended) -Starting Patroneo through the Non Session Manager after you installed patroneo system-wide -is the recommended and only supported way. Start non-session-manager and load or create a new -session. Then use the button "Add Client to Session" and type in patroneo. -It should appear with an icon in the list and open its GUI. +## Starting -## Starting through NSM without building / installation +There are multiple ways to run Patroneo which should give you the flexibility to configure your +system as you want. -Starting Patroneo 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 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. +We make no distinction if you installed Patroneo yourself or through the distributions package-manager. -After extracting the release archive create a symlink from `patroneo` into your PATH. e.g. /usr/bin -or ~/bin, if that exists on your system. +The differences are: With or without NSM, with or without sound, installed or from the source dir. +The permutations are too many to describe them all in detail, but here are some useful modes: -This mode needs calfbox to be installed systemwide. Please consult https://github.com/kfoltman/calfbox +### Installed with Non Session Manager (recommended) +Starting Patroneo through the Non Session Manager after you installed patroneo system-wide +is the recommended and only supported way. Start non-session-manager and load or create a new +session. Then use the button "Add Client to Session" and type in `patroneo`. +It should appear with an icon in the list and open its GUI. -## Starting without Non Session Manager +### Installed without NSM You need to start patroneo from a terminal (or create a starter script). `patroneo --save DIRECTORY` @@ -97,10 +94,29 @@ Sending SIGUSR1 to the program in this mode will trigger a save. Closing through your window manager in this mode will actually quit the application without a 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. +## From source directory +You can run Patroneo after extracting the release archive or cloning from git, without installation. + +### Calfbox +"Calfbox" is the name of our internal realtime midi/audio python module. + +* You can either choose to install the module systemwide, which will make running all Laborejo Software Suite programs more convenient (when run from the source dir). Please consult https://github.com/kfoltman/calfbox. +* Or you just run `./configure` and `make` without subsequent install, which creates a `site-packages` directory in the source dir. +* A third option is `patroneo --mute` which runs without sound at all and does not need calfbox. + +### From source directory with NSM +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 `patroneo` into your PATH. e.g. /usr/bin +or ~/bin, if that exists on your system. + +If you compiled without installing you can also symlink to `./patroneo.bin` + +### From source dir without NSM +Use `./patroneo --save` (see above). If you compiled without installing you can also run `./patroneo.bin` -## Without NSM, no install or PATH, without calfbox/sound +### No NSM, no Make, No Sound Combining the above options you can start the program directly after unpacking or cloning from git: `./patroneo --save /tmp --mute` diff --git a/documentation/out/english.html b/documentation/out/english.html index 9ce57b9..4796c51 100644 --- a/documentation/out/english.html +++ b/documentation/out/english.html @@ -1121,7 +1121,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft diff --git a/documentation/out/german.html b/documentation/out/german.html index 47d2abd..8ceee65 100644 --- a/documentation/out/german.html +++ b/documentation/out/german.html @@ -1202,7 +1202,7 @@ Das Programm ist in zwei Teile aufgeteilt: Ein gemeinsames "Template" (für alle diff --git a/index.html b/index.html index 0226bdc..9b3d88a 100644 --- a/index.html +++ b/index.html @@ -90,27 +90,24 @@ make sudo make install -

Starting through the Non Session Manager after installation (recommended)

+

Starting

-

Starting Patroneo through the Non Session Manager after you installed patroneo system-wide -is the recommended and only supported way. Start non-session-manager and load or create a new -session. Then use the button “Add Client to Session” and type in patroneo. -It should appear with an icon in the list and open its GUI.

+

There are multiple ways to run Patroneo which should give you the flexibility to configure your +system as you want.

-

Starting through NSM without building / installation

+

We make no distinction if you installed Patroneo yourself or through the distributions package-manager.

-

Starting Patroneo 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 differences are: With or without NSM, with or without sound, installed or from the source dir. +The permutations are too many to describe them all in detail, but here are some useful modes:

-

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 patroneo into your PATH. e.g. /usr/bin -or ~/bin, if that exists on your system.

+

Installed with Non Session Manager (recommended)

-

This mode needs calfbox to be installed systemwide. Please consult https://github.com/kfoltman/calfbox

+

Starting Patroneo through the Non Session Manager after you installed patroneo system-wide +is the recommended and only supported way. Start non-session-manager and load or create a new +session. Then use the button “Add Client to Session” and type in patroneo. +It should appear with an icon in the list and open its GUI.

-

Starting without Non Session Manager

+

Installed without NSM

You need to start patroneo from a terminal (or create a starter script).

@@ -128,10 +125,36 @@ directory to append the unique ID provided by NSM.

Closing through your window manager in this mode will actually quit the application without a 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.

+

From source directory

+ +

You can run Patroneo after extracting the release archive or cloning from git, without installation.

+ +

Calfbox

+ +

“Calfbox” is the name of our internal realtime midi/audio python module.

+ + + + +

From source directory with NSM

+ +

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 patroneo into your PATH. e.g. /usr/bin +or ~/bin, if that exists on your system.

+ +

If you compiled without installing you can also symlink to ./patroneo.bin

+ +

From source dir without NSM

+ +

Use ./patroneo --save (see above). If you compiled without installing you can also run ./patroneo.bin

-

Without NSM, no install or PATH, without calfbox/sound

+

No NSM, no Make, No Sound

Combining the above options you can start the program directly after unpacking or cloning from git: