Document updates for the R3 release
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index dde40ff..8ffe37b 100644 (file)
@@ -1,5 +1,5 @@
-Release 3 (WiP)\r
----------------\r
+Release 3 (13th November 2017)\r
+------------------------------\r
 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options\r
 1) Added an Exception Vector Table browser window\r
 2) Modified the About window to update the credits list in a more appropriate way\r
@@ -11,6 +11,7 @@ Release 3 (WiP)
 7) Added the --es-all, --es-ui, --es-alpine & --es-debugger options to erase specific settings\r
 8) Added a keybindings tab and adapted the configuration dialog tabs\r
 -- User can modify the keybindings where appropriate\r
+-- Keybindings UI is displayed based on the option used (--debugger, -- alpine)\r
 9) Fixed a crash, in Release mode, when the HW labels setting is turn on\r
 10) Solved an interference between the HW labels setting and the one used by the debugger\r
 -- The setting is now only the reference used\r
@@ -23,6 +24,8 @@ Release 3 (WiP)
 15) Improved the .heap section detection to avoid a detection error\r
 -- Depend vlink version, .heap section may have an Alloc flag\r
 16) Fixed a crash when DWARF information does references to missing source code files\r
+17) Added a Local browser window for local variables\r
+18) Project has switched to Visual Studio 2017 and QT 5.9.1 library\r
 \r
 Release 2 (3rd September 2017)\r
 ------------------------------\r
@@ -85,11 +88,11 @@ Release 0 (5th January 2017)
 \r
 Known issues\r
 ============\r
-1) Video output is not displayed due to my OpenGL / QT5 integration with VS 2015\r
+1) Video output is not displayed due to my OpenGL / QT5 5.5.1 integration with VS 2015 but solved when using the QT 5.9.1 package for VS 2017\r
 2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution\r
 -- Need to trace over the BPM or unset the BPM\r
 3) To handle DWARF 2 issues with GCC, the code must be compiled with the -gdwarf-2 option\r
-4) The Watch variables list may display not available (N/A) type information\r
+4) The Local & Watch variables list may display not available (N/A) type information\r
 -- Such missing information may be included in future release\r
 5) The 2MB mirroring is no longer applied in case of --dram-max option usage\r
 6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted\r
@@ -117,16 +120,17 @@ Legacy issues/hints
 Project information\r
 ===================\r
 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)\r
-2) Visual Studio 2015 project support for 64 bits\r
-3) libelf 0.8.13 library 64bits for VS 2015\r
-4) libdwarf 1.41 library 64bits for VS 2015, cygwin64 & Msys2/MinGW64\r
+2) Visual Studio 2015/2017 project support for 64 bits\r
+3) libelf 0.8.13 library 64bits for VS 2015/2017\r
+4) libdwarf 1.41 library 64bits for VS 2015/2017, cygwin64 & Msys2/MinGW64\r
 5) QT 5.5.1 library 64bits for VS 2015\r
-6) Zlib 1.2.8 library 64bits for VS 2015\r
-7) SDL 1.2.15 library 64bits for VS 2015\r
-8) The original make files have been modified to follow the requirements and modifications\r
-9) The 'Rx' word has been added to the emulator name to make distinction with the official version\r
-10) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx\r
-11) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements\r
+6) QT 5.9.1 library 64bits for VS 2017\r
+7) Zlib 1.2.8 library 64bits for VS 2015/2017\r
+8) SDL 1.2.15 library 64bits for VS 2015\r
+9) The original make files have been modified to follow the requirements and modifications\r
+10) The 'Rx' word has been added to the emulator name to make distinction with the official version\r
+11) The project source is set at https://github.com/djipi/Virtual-Jaguar-Rx\r
+12) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements\r
 -- Text / License terms are the same\r
 \r
 \r