.gitignore file update
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_ReleaseNotes.txt
index 36d75d5..73f84e8 100644 (file)
@@ -1,6 +1,6 @@
-Release 3 (TBC)\r
+Release 3 (WiP)\r
 ---------------\r
-0) Fixed the windows respawning in the next emulator launch without --alpine or --debugger options\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
 -- Updated the emulator application credits line\r
@@ -9,6 +9,12 @@ Release 3 (TBC)
 5) Added ui, alpine & debugger groups in the settings\r
 6) Added the possibility to erase settings\r
 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
+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
+11) Fixed the SP (Stack) window UI potential missing data\r
 \r
 Release 2 (3rd September 2017)\r
 ------------------------------\r
@@ -71,7 +77,7 @@ Release 0 (5th January 2017)
 \r
 Known issues\r
 ============\r
-1) Video output is not displayed due to OpenGL / QT5 integration problems with VS 2015\r
+1) Video output is not displayed due to my OpenGL / QT5 integration with VS 2015\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
@@ -82,22 +88,26 @@ Known issues
 -- The application needs to set the SP (Stack) in accordance\r
 7) The Exception Vector Table broswer window displays only 65 vectors\r
 -- Missing vectors may be added in future release\r
+8) User needs to manualy check if the Atari Jaguar executable match his source code files\r
+-- Otherwise, source code and assembly may not match or leads to instabilities\r
 \r
 Cosmetic / UX issues\r
 ====================\r
 1) The SP (Stack) icon color backgound doesn't look similar with the other ones\r
 2) The emulator status option has no icon\r
 3) The SP (Stack) window size always open at a forced size no matter if the size has been changed\r
+4) Not every features have associated keybindings\r
 \r
 Legacy issues/hints\r
 ===================\r
 1) Emulator seems to have easter egg(s)\r
 -- The option --yarrr displays a single message and end the application\r
+-- Pressing F8, while in the main window, will create an extra message in the log file\r
 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option\r
 \r
 Project information\r
 ===================\r
-1) Code based on the Shamus Hammons source code available via Gethub by the 13th June 2016\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
@@ -115,4 +125,4 @@ Download statistics
 -------------------\r
 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017\r
 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017\r
-No downloads available for the Release 2
\ No newline at end of file
+No downloads statistics available for the Release 2
\ No newline at end of file