Release notes for SimDiff Linux
---------------------------------------
Release notes for SimDiff can be found at 'docs/release-notes.txt'

Supported platforms
--------------------
See INSTALL for a list of supported Linux platforms.


Installing SimDiff
-------------------
See INSTALL for a instructions to install SimDiff and its prerequisites.


Running SimDiff
-------------------
Once SimDiff is installed, you can launch it by running the "sd4" command
from a shell console.  For example, to show the help:

	[user@localhost ~] sd4 -h

You can also configure SimDiff to integrate with a version control system.  
Please see the SimDiff website for more information:
https://www.ensoftcorp.com/simdiff/version-control-system-integration/


Capturing Screenshots in a Headless Environment
------------------------------------------------
If you have installed MATLAB and Simulink in a headless environment
such as a Docker container, you may be able to capture screenshots in reports 
if you run an X virtual framebuffer (Xvfb):

$ export DISPLAY=:99
$ sudo Xvfb "$DISPLAY" -screen 0 1024x768x24 &
$ sd4 -r right.mdl -l left.mdl -htmlScreenshots on -export /tmp/report.html


Known Issues on Linux
-----------------------
- Auto-detection of MATLAB installations is not yet supported.

- Sometimes the window management does not behave as expected, and MATLAB windows
  may not be positioned correctly.

- The language selector tool is not currently supported.  Please contact EnSoft
  if you need help changing the language.

- Spaces in the installation path may cause SimDiff to fail.

- SimDiff GUI looks tiny on HighDPI screen with a scaling of 200% or higher.
  Java does not properly handle this use case on Linux. However, there is a workaround
  to fix this problem.
  You can edit the sd4 shell script that launches SimDiff and add the 
  sun.java2d.uiScale property to indicate the current scaling setting right after 
  the java command (last line).
  For example, if the system scaling is set to 200%, then you should specify:
	-Dsun.java2d.uiScale=2.0

  Please, contact support@ensoftcorp.com if you need further assistance.
  