From a342c4d48c17c55d5ab2f90a466fe8dcdc5292fe Mon Sep 17 00:00:00 2001
From: Nils <>
Date: Sat, 2 Feb 2019 13:28:18 +0100
Subject: [PATCH] Update documentation
Former-commit-id: fa1c9f6f7c866c964759d23d866f05f18cb96965
---
CHANGELOG | 1 +
README.md | 22 ++++++++++++++++++----
index.html | 22 ++++++++++++++++++----
3 files changed, 37 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
index 96b1a92..a7170d3 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -4,6 +4,7 @@ In --save mode SIGUSR1 can be send to trigger a save.
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
Added tool to convert the grouping and step count without losing data or changing the music.
diff --git a/README.md b/README.md
index 0905de6..8fdc4cf 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,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)
#### Build Dependencies
@@ -72,13 +72,14 @@ It should appear with an icon in the list and open its GUI.
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 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 `patroneo` 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 patroneo from a terminal (or create a starter script).
@@ -99,3 +100,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:
+
+`./patroneo --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.
+
diff --git a/index.html b/index.html
index 05b28f8..41335e9 100644
--- a/index.html
+++ b/index.html
@@ -62,7 +62,7 @@ Download the latest code release on Glibc
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 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 patroneo
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
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.
+Combining the above options you can start the program directly after unpacking or cloning from git:
+ +./patroneo --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.
+