update docs

Author: arch

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

@@ -1,4 +1,6 @@
-# Build
+# Build from Source
+
+For Windows user i recommend to use the release version from [github release page](https://github.com/michael-mueller-git/Python-Funscript-Editor/releases)
 
 ## Windows
 

docs/app/docs/user-guide/ofs-integration.md

@@ -8,8 +8,8 @@ Currently we use a hacky lua script to communicate between the Python Funscript
 2. Extract the Archiv to an Path without special character or spaces.
 3. Copy the `funscript_generator.lua` script ([`Repository/contrib/OpenFunscripter`](https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/contrib/OpenFunscripter)) to `data/lua` in your OFS directory.
 4. Open the `funscript_generator.lua` file and adjust the `Settings.FunscriptGenerator` and `Settings.TmpFile` variable.
-   - `Settings.FunscriptGenerator`: point to the extracted Python Funscript Editor program. Use `\\` instead of `/` symbols in the path string!
-   - `Settings.TmpFile`: specifies a temporary file where to store the result (must be a file not a directory!). The file will be overwritten automatically the next time the generator is started!
+   - `Settings.FunscriptGenerator`: Point to the extracted Python Funscript Editor program. Use `\\` instead of `/` symbols in the path string!
+   - `Settings.TmpFile`: Specifies a temporary file location where to store the result (must be a file not a directory!). The file does not have to exist at the moment. The specified file will be generated from the Python Funscript Editor and will be overwritten automatically at the next time the generator is started!
 5. Now launch OFS.
 6. Navigate to `View : Special functions : Custom Functions` and select the `funscript_generator.lua` entry. Click the Button `Bind Script` (This may trigger the funscript generator, just ignore it for now).
 7. Navigate to `Options : Keys : Dynamic` and insert a shortcut for the funscript generator.

docs/app/site/index.html

@@ -204,5 +204,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.1.2
-Build Date UTC : 2021-06-26 10:02:28.282446+00:00
+Build Date UTC : 2021-06-26 10:28:30.067521+00:00
 -->

docs/app/site/search/search_index.json

@@ -118,8 +118,8 @@ <h2 id="installation-windows">Installation (Windows)</h2>
 <li>Extract the Archiv to an Path without special character or spaces.</li>
 <li>Copy the <code>funscript_generator.lua</code> script (<a href="https://github.com/michael-mueller-git/Python-Funscript-Editor/tree/main/contrib/OpenFunscripter"><code>Repository/contrib/OpenFunscripter</code></a>) to <code>data/lua</code> in your OFS directory.</li>
 <li>Open the <code>funscript_generator.lua</code> file and adjust the <code>Settings.FunscriptGenerator</code> and <code>Settings.TmpFile</code> variable.</li>
-<li><code>Settings.FunscriptGenerator</code>: point to the extracted Python Funscript Editor program. Use <code>\\</code> instead of <code>/</code> symbols in the path string!</li>
-<li><code>Settings.TmpFile</code>: specifies a temporary file where to store the result (must be a file not a directory!). The file will be overwritten automatically the next time the generator is started!</li>
+<li><code>Settings.FunscriptGenerator</code>: Point to the extracted Python Funscript Editor program. Use <code>\\</code> instead of <code>/</code> symbols in the path string!</li>
+<li><code>Settings.TmpFile</code>: Specifies a temporary file location where to store the result (must be a file not a directory!). The file does not have to exist at the moment. The specified file will be generated from the Python Funscript Editor and will be overwritten automatically at the next time the generator is started!</li>
 <li>Now launch OFS.</li>
 <li>Navigate to <code>View : Special functions : Custom Functions</code> and select the <code>funscript_generator.lua</code> entry. Click the Button <code>Bind Script</code> (This may trigger the funscript generator, just ignore it for now).</li>
 <li>Navigate to <code>Options : Keys : Dynamic</code> and insert a shortcut for the funscript generator.</li>