improve build/install instructions

Author: arch

README.md

@@ -8,6 +8,10 @@ A Python program that use Computer Vision to predict the funscript actions. Most
 
 The application documentation is located in [`./docs/app/docs`](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs)
 
+## Contribute
+
+If you want to contribute to the project and make it better, your help is very welcome. Currently i don’t have project specific contribution instructions. But as long as the code is clean and the function is useful for the project, I will be very willing to merge your pull requests.
+
 ## License
 
 Distributed under the MIT License. See `LICENSE` for more information.

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

@@ -4,21 +4,29 @@ For Windows user i recommend to use the release version from [github release pag
 
 ## Windows
 
-Use `pyinstaller` in anaconda environment with all packages from `requirements.txt` set up. Then run:
+We use [pyinstaller](https://pypi.org/project/pyinstaller/) in [miniconda](https://docs.conda.io/en/latest/miniconda.html) environment to create an Windows executable.
+
+First download and install [miniconda](https://docs.conda.io/en/latest/miniconda.html) (If you have already [anaconda](https://www.anaconda.com/) installed on your computer you can skip this step). Then run the following commands in the project root directory:
 
 ```
-pip install pyinstaller
+conda env create -f environment.yaml
+conda activate build
 build.bat
 ```
 
-This create the Windows Package in `./dist`
+This create the Windows executable in `./dist`.
 
-## Pip-Package (Recommend for Linux)
+Finally you can remove the build environment with `conda env remove -n build`
 
-Generate distribution package of this project. These are archives that can be uploaded to an local Package Index and can be installed by pip.
+## Ubuntu
 
 ```bash
-make docs package
+sudo apt update
+sudo add-apt-repository ppa:savoury1/ffmpeg4
+sudo apt install git python3 python3-pip python3-sphinx python3-opencv mkdocs python3-pyqt5 ffmpeg libmpv-dev
+git clone https://github.com/michael-mueller-git/Python-Funscript-Editor.git
+cd Python-Funscript-Editor
+pip install -r requirements.txt
+make all
+python3 funscript-editor.py
 ```
-
-This create the distribution package in `./dist`. Or simply type `make all` to build and install the package.

docs/code/generate_doc.sh

@@ -5,7 +5,17 @@ NAME="funscript_editor"
 IGNORE=( )
 
 if ! command -v sphinx-apidoc ; then
-    pip3 install sphinx sphinx-rtd-theme
+    if command -v pacman ; then
+        # Arch based
+        sudo pacman -Sy python3-sphinx python-sphinx_rtd_theme
+    elif command -v apt ; then
+        # Debian based
+        sudo apt update
+        sudo apt install python3-sphinx
+        pip3 install sphinx-rtd-theme
+    else
+        pip3 install sphinx sphinx-rtd-theme
+    fi
 fi
 
 WDIR=$PWD

requirements.txt

@@ -5,13 +5,9 @@ humanfriendly
 kiwisolver
 matplotlib
 numpy
-opencv-contrib-python
 Pillow
 pynput
 pyparsing
-PyQt5
-PyQt5-Qt5
-PyQt5-sip
 pyreadline
 python-dateutil
 python-mpv