updated release for 5.1.0

releases/RELEASE_v5.1.0.txt

@@ -0,0 +1,151 @@
+SLS Detector Package 5.1.0 released on 22.03.2020 (Minor Release)
+===================================================================
+
+This document describes the differences between 5.1.0 and 5.0.1 releases.   
+
+
+
+    CONTENTS
+    --------
+    1.  New Features
+    2.  Resolved Issues
+    3.  Known Issues
+    4.  Firmware Requirements
+    5.  Download, Documentation & Support
+
+
+
+
+1. New Features
+===============
+
+    Client
+    ------
+
+    1. Added settings and threshold features for Mythen3.
+    2. Internal modification of acquire for Mythen3.
+    3. Added getMaster for Mythen3
+    4. Mythen3, API function to set pattern from memory
+
+
+    Mythen3 server
+    -----------------
+
+    1. Setting timing to auto, sets timing to trigger for slaves
+    
+
+2. Resolved Issues
+==================
+
+
+    Receiver
+    --------
+
+    1.  Current code only calls Implementation::setDetectorType from constructor, 
+	    but potential memory leak if called out of constructor context. Fixed.
+
+
+    Client
+    ------
+
+    1.  Fixed missing scanParameters class in Python 
+
+    2.  cmk.sh refactored to have better option handling
+
+    3.  Fixed hardcoded path accidentally ending up in the exported CMake package
+
+    Server
+    --------
+
+    1.  Bottom port not mirrored correctly for Eiger quad
+
+
+
+
+
+3. Firmware Requirements
+========================
+        
+    Mythen3: 0x210201
+    Jungfrau: 0x210218 (1.0 pcb)
+              0x200721 (2.0 pcb, not changed)
+
+    Other detectors no updates from 5.0.0
+
+
+
+4. Known Issues
+===============
+
+    No updates from 5.0.0
+
+
+
+5. Download, Documentation & Support
+====================================
+
+    Download
+    --------
+    
+    The Source Code:
+         https://github.com/slsdetectorgroup/slsDetectorPackage
+            
+    Documentation
+    -------------
+    
+    Installation:
+        https://slsdetectorgroup.github.io/devdoc/installation.html#
+        
+    Firmware Upgrade:
+        https://slsdetectorgroup.github.io/devdoc/firmware.html
+
+    Detector Server upgrade:
+        https://slsdetectorgroup.github.io/devdoc/serverupgrade.html
+
+    Detector Simulators:
+        https://slsdetectorgroup.github.io/devdoc/virtualserver.html
+
+    Consuming slsDetectorPackage:
+        https://slsdetectorgroup.github.io/devdoc/consuming.html
+        
+    API Examples:
+        https://github.com/slsdetectorgroup/api-examples
+
+    Command Line Documentation:
+        https://slsdetectorgroup.github.io/devdoc/commandline.html
+
+    Quick Start Guide:
+        https://slsdetectorgroup.github.io/devdoc/quick_start_guide.html
+        
+    C++ API Documentation:
+        https://slsdetectorgroup.github.io/devdoc/detector.html
+       
+    C++ API Example:
+        https://slsdetectorgroup.github.io/devdoc/examples.html#
+        
+    Python API Documentation:
+        https://slsdetectorgroup.github.io/devdoc/pygettingstarted.html
+
+    Python API Example:
+        https://slsdetectorgroup.github.io/devdoc/pyexamples.html
+
+    Receivers (including custom receiver):
+        https://slsdetectorgroup.github.io/devdoc/receivers.html
+        https://slsdetectorgroup.github.io/devdoc/slsreceiver.html
+
+    TroubleShooting:
+        https://slsdetectorgroup.github.io/devdoc/troubleshooting.html
+        
+    Further Documentation:
+        https://www.psi.ch/en/detectors/documentation
+        
+    Info on Releases:
+        https://www.psi.ch/en/detectors/software
+
+
+    Support
+    -------
+
+        dhanya.thattil@psi.ch
+        erik.frojdh@psi.ch
+