Update documentation

CHANGELOG.md

@@ -1,23 +1,39 @@
-
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] 
-  
+## [Unreleased]
+
 ## [0.1.0.4] - 2021-12-29
+
 First release.  
 Installation see project description.
 
 ### Added
+
 ### Changed
+
 ### Fixed
- 
+
 ## [0.1.0.5] - 2024-05-15
 
 ### Added
+
 ### Changed
+
 * Update requirements
+
+### Fixed
+
+## [0.1.0.6] - 2024-05-18
+
+### Added
+
+### Changed
+
+* Documentation
+
 ### Fixed

README.md

@@ -1,67 +1,87 @@
 # DRRemote
 
 DRRemote is a python modul which offers access to Davinci Resolve Studio.
-At the time the functionality is very basic. DRRemote is used in conjunction with [LRDavinci](https://github.com/sto3014/LRDavinci).
+At the time the functionality is very basic. DRRemote is used in conjunction
+with [LRDavinci](https://github.com/sto3014/LRDavinci).
 LRDavinci is a Lightroom plug-in for Davinci Resolve Studio
 
 ## Features
+
 * Changes the current timeline
-* Retrieves the attributes for the current timeline 
-  * name, type and ipaddress of database
-  * name of project
-  * name of timeline
+* Retrieves the attributes for the current timeline
+    * name, type and ipaddress of database
+    * name of project
+    * name of timeline
 
 ## Requirements
-* Python ~= 3.12 
+
+* Python >= 3.6
 * Davinci Resolve Studio (license is needed for Davinci Resolve's Python API).
 
 ## Installation
+
 1. [Python](https://www.python.org/downloads/)  
-    You need to install version ~= 3.12
-2. PIP 
-   * Windows
+   You need to install version >= 3.6
+2. Install/update PIP
+    * Windows
         * python -m pip install --upgrade pip
-   * macOS
-        * curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py  
+    * macOS
+        * curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
         * python get-pip.py
 3. DRRemote
-   * pip install drremote
-4. Davinci Resolve scripting environment  
+    * pip install drremote
+4. Set the Davinci Resolve scripting environment.
    See readme file:  
-  macOS  
-  ```/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting/README.txt```  
-  Windows  
-    ```%PROGRAMDATA%\Blackmagic Design\DaVinci Resolve\Support\Developer\Scripting\README.txt```
+   macOS  
+   ```/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting/README.txt```  
+   Windows  
+   ```%PROGRAMDATA%\Blackmagic Design\DaVinci Resolve\Support\Developer\Scripting\README.txt```
+
 ## Usage
-You must execute __DRRemote__ in a command prompt (Windows) or terminal (macOS).  
-Remarks for Windows:  
-After you installed drremote with PIP, an executable is created as well: 
+
+__DRRemote__ must be executed in a command prompt (Windows) or terminal (macOS) window. You can do so by calling
+the drremote executable/script. To execute drremote you must use the full path or extend your PATH variable.
+
+* Windows:
+
+```
+%APPDATA%\Programs\Python\Python36\Scripts\drremote.exe
+```
+
+* macOS
+
 ```
-%APPDATA%\Programs\Python\Python36\Scripts\drremote.exe.
+/Library/Frameworks/Python.framework/Versions/3.6/bin/drremote
 ```
-To execute drremote.exe you must use the full path or extend your PATH variable.
+
 
 A simple example:
+
 * Start Davinci Resolve Studio, open a project and select a timeline
 * Open a Command Prompt/Terminal and type:
+
 ```
 drremote -m gettimeline -o out.txt
 ```
+
 If successful you find the gathered information in file out.txt in your current directory:
+
 ```
 Success
 project=Snippets
 timeline=2021-12-10-First Snow
 database=2021:Disk
 ```
+
 If you get an error, you may find some more information in the log logfile:
-* MacOS  
-  * $TMPDIR/drremote.log
-* Windows  
-  * %TEMP%/drremote.log
 
+* MacOS
+    * $TMPDIR/drremote.log
+* Windows
+    * %TEMP%/drremote.log
 
 For the commandline arguments see ```drremote --help```:
+
 ```
 usage: drremote [-h] -m {settimeline,gettimeline} [-p PROJECT [PROJECT ...]]
                 [-t TIMELINE [TIMELINE ...]] [-d DATABASE [DATABASE ...]] -o
@@ -86,17 +106,22 @@ optional arguments:
                         second connection attempt
 ```
 
-###Examples  
-#### Set the current timeline in Davinci resolve   
+###Examples
+
+#### Set the current timeline in Davinci resolve
+
 ```
 drremote -m settimeline -t "2021-12-10-First Snow" -p Snippets -d 2021:disk -o out.txt
 ```  
 
-#### Get the current timeline IDs  
+#### Get the current timeline IDs
+
 ```
 drremote -m gettimeline -o out.txt
 ```
+
 The result is written into __out.txt__:
+
 ```
 Success
 project=Snippets

install.sh

@@ -8,7 +8,7 @@ export PATH=`echo $PATH | tr ":" "\n" |  grep -v "venv" | tr "\n" ":"`
 ./package.sh
 
 # Install global
-# pip3 install dist/${PROJECT}*.whl --force-reinstall
+pip3 install dist/${PROJECT}*.whl --force-reinstall
 
 
 

setup.py

@@ -8,7 +8,7 @@
 with open('README.md', encoding='utf-8') as f:
     long_description = f.read()
 
-__version__ = '0.1.0.5'
+__version__ = '0.1.0.6'
 setup(
     name='drremote',
     version=__version__,