Skip to content

Commit 0fccdc4

Browse files
author
arch
committed
update docs
1 parent c57a541 commit 0fccdc4

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

docs/app/docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A Python program that use Computer Vision to predict the funscript actions. Most
77
## User-Guide
88

99
- [Algorithms](user-guide/algorithms.md)
10-
- [Build](user-guide/build.md)
11-
- [Config](user-guide/config.md)
10+
- [Build Application from Source](user-guide/build.md)
11+
- [Application Config](user-guide/config.md)
1212
- [OFS Integration](user-guide/ofs-integration.md)
13-
- [UI](user-guide/ui.md)
13+
- [Build in UI](user-guide/ui.md)

docs/app/docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A Python program that use Computer Vision to predict the funscript actions. Most
77
## User-Guide
88

99
- [Algorithms](user-guide/algorithms.html)
10-
- [Build](user-guide/build.html)
11-
- [Config](user-guide/config.html)
10+
- [Build Application from Source](user-guide/build.html)
11+
- [Application Config](user-guide/config.html)
1212
- [OFS Integration](user-guide/ofs-integration.html)
13-
- [UI](user-guide/ui.html)
13+
- [Build in UI](user-guide/ui.html)

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
For Windows user i recommend to use the release version from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases)
44

5-
## Windows
5+
## Windows 10
66

77
We use [pyinstaller](https://pypi.org/project/pyinstaller/) in [miniconda](https://docs.conda.io/en/latest/miniconda.html) environment to create an Windows executable.
88

@@ -20,7 +20,11 @@ Finally you can remove the build environment with `conda env remove -n build`
2020

2121
## Ubuntu 20.04 LTS
2222

23-
The OpenCV Package in Ubuntu use the GTK Backend for the preview window. This will cause freezes of the UI, because i use Qt threads in my code. The Arch Linux OpenCV library was compiled with QT (see `python3 -c "import cv2; print(cv2.getBuildInformation())"` output) so no problem here. To use the Application on Ubuntu you have to compile `OpenCV + OpenCV contrib` with `-D WITH_QT=ON` flag from source. Or simply use [miniconda](https://docs.conda.io/en/latest/miniconda.html). They include OpenCV compiled with Qt support. After you have setup miniconda simply type the following commands to use Python-Funscript-Editor on Ubuntu:
23+
The OpenCV Package in Ubuntu use the GTK Backend for the preview window. This will cause freezes of the UI, because i use Qt threads in my code. The Arch Linux OpenCV library was compiled with QT (see `python3 -c "import cv2; print(cv2.getBuildInformation())"` output) so no problem here. To use the Application on Ubuntu you have to compile `OpenCV + OpenCV contrib` with `-D WITH_QT=ON` flag from source. Or simply use [miniconda](https://docs.conda.io/en/latest/miniconda.html). They include OpenCV compiled with Qt support.
24+
25+
### Miniconda
26+
27+
After you have setup [miniconda](https://docs.conda.io/en/latest/miniconda.html) on your Ubuntu machine simply type the following commands to use Python-Funscript-Editor on Ubuntu:
2428

2529
```bash
2630
sudo apt install -y make git gcc g++ libmpv-dev libatlas-base-dev

0 commit comments

Comments
 (0)