add reamde

Author: arch

contrib/Installer/README.md

@@ -0,0 +1,29 @@
+# MTFG OFS Extension Installer
+
+## Usage
+
+1. Download OFS from https://github.com/OpenFunscripter/OFS/releases.
+2. Install OFS if you prefer the installer version (`exe`) else extract the OFS archive.
+3. Start OFS at least one and close it again.
+4. Download the MTFG OFS Extension Installer from https://github.com/michael-mueller-git/Python-Funscript-Editor/releases
+5. Run Install
+6. Open OFS and activate the extension.
+7. Add global key binding for the extension in OFS
+
+## Build Installer from Source
+
+I recommend to download the installer from [release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases) in the assets section.
+
+If you want to build this installer from source use miniconda environment to build the executable.
+
+First download and install miniconda (If you have already anaconda installed on your computer you can skip this step). Then run the following commands in the project root directory:
+
+```
+conda env create -f environment_windows.yaml
+conda activate build-installer
+build.bat
+```
+
+This create the Windows executable in `./dist`.
+
+Finally you can remove the build environment with `conda env remove -n build-installer`