Skip to content

Commit 328dced

Browse files
author
arch
committed
update docs
1 parent 7903b46 commit 328dced

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/app/docs/user-guide/algorithms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Idea: By using [OpenCV Tracker](https://learnopencv.com/object-tracking-using-op
2222

2323
### Improvements
2424

25-
- You can change the OpenCV tracker in the source code which predicts the position. OpenCV offers several trackers which differ in prediction accuracy and processing speed. See also [OpenCV Tracker](https://learnopencv.com/object-tracking-using-opencv-cpp-python/).
25+
- You can change the OpenCV tracker which predicts the position. OpenCV offers several trackers which differ in prediction accuracy and processing speed. See also [OpenCV Tracker](https://learnopencv.com/object-tracking-using-opencv-cpp-python/).
2626

2727
- You can set the number of frames that are interpolated by the `skip_frames` parameter. 0 means that the OpenCV tracker delivers a prediction for each frame. This is slower but more accurate. Or if greater than zero, the individual frames are skipped and then the tracking boxes are interpolated, which increases the processing speed but decreases the accuracy. I have set the value to 1, i.e. every 2nd frame is skipped and interpolated. Which provides a good mix of accuracy and speed.
2828

29-
- It is recommended to use a low resolution video e.g. 4K for generating the funscript actions, as the processing speed is higher.
29+
- It is recommended to use a low resolution video e.g. 1080p or 4K for generating the funscript actions, as the processing speed is higher.

docs/app/docs/user-guide/build.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,14 @@ sudo pacman -Sy python-opencv python-pyqt5
6565
```
6666

6767
All other required python packages can be installed from pip.
68+
69+
## Flatpak
70+
71+
The repository contains an flatpak build recipe that can be used to build an flatpak app. You can build the flatpak with the `build_flatpak.sh` script in the project root directory. The build script generate the `PythonFunscriptEditor.flatpak` package that can be installed with `flatpak install --user PythonFunscriptEditor.flatpak` on the system.
72+
73+
Limitation of the flatpak application:
74+
75+
- No public release in a flatpak repository available. You have to build the flatpak local.
76+
- Slow build process.
77+
- Flatpak need non-privileged user namespaces enabled (`sysctl kernel.unprivileged_userns_clone=1'`).
78+
- The System-Theme is not applied to the application. The problem is that my recipe use conda packages which isolates the python packages inside the flatpak sandbox and we have no access to the system theme. To fix this we have to build all python packages in the flatpak recipe from source and include the system theme inside the flatpak.

0 commit comments

Comments
 (0)