Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-25 07:35:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-03-12 12:23:42 +01:00
parent 608d8a3c09
commit 1323061e3b
4 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CHANGELOG.md
View file

@ -2,6 +2,20 @@
[[_TOC_]] [[_TOC_]]
## Version 2.0.1 (in development)
### Release overview
### Detailed list of changes
### Bug fixes
* Fixed several container overflows in GuiTextEditKeyboardPopup that could lead to rare crashes when running on an ARM processor
* Fixed a container overflow in ViewController that could lead to rare crashes when running on an ARM processor
* (macOS) When opening the main menu an error message was logged about accessing a nonexistent ShowQuitMenu setting
**Release date:** TBD
## Version 2.0.0 ## Version 2.0.0
**Release date:** 2023-03-11 **Release date:** 2023-03-11

5
INSTALL-DEV.md
View file

@ -540,11 +540,6 @@ export UBSAN_OPTIONS=print_stacktrace=1
These tools aren't very useful without debug symbols so only use them for a Debug or Profiling build. Note that ASAN and TSAN can't be combined. These tools aren't very useful without debug symbols so only use them for a Debug or Profiling build. Note that ASAN and TSAN can't be combined.
Specifically on macOS it seems as if AddressSanitizer generates a lot of false positives regarding container overflows, so it may be necessary to ignore these:
```
export ASAN_OPTIONS=detect_container_overflow=0
```
Running `make -j6` (or whatever number of parallel jobs you prefer) speeds up the compilation time if you have cores to spare. Running `make -j6` (or whatever number of parallel jobs you prefer) speeds up the compilation time if you have cores to spare.
Running ES-DE from the build directory may be a bit flaky as there is no Info.plist file available which is required for setting the proper window mode and such. It's therefore recommended to run the application from the installation directory for any more in-depth testing. But normal debugging can of course be done from the build directory. Running ES-DE from the build directory may be a bit flaky as there is no Info.plist file available which is required for setting the proper window mode and such. It's therefore recommended to run the application from the installation directory for any more in-depth testing. But normal debugging can of course be done from the build directory.

5
INSTALL.md
View file

@ -538,11 +538,6 @@ export UBSAN_OPTIONS=print_stacktrace=1
These tools aren't very useful without debug symbols so only use them for a Debug or Profiling build. Note that ASAN and TSAN can't be combined. These tools aren't very useful without debug symbols so only use them for a Debug or Profiling build. Note that ASAN and TSAN can't be combined.
Specifically on macOS it seems as if AddressSanitizer generates a lot of false positives regarding container overflows, so it may be necessary to ignore these:
```
export ASAN_OPTIONS=detect_container_overflow=0
```
Running `make -j6` (or whatever number of parallel jobs you prefer) speeds up the compilation time if you have cores to spare. Running `make -j6` (or whatever number of parallel jobs you prefer) speeds up the compilation time if you have cores to spare.
Running ES-DE from the build directory may be a bit flaky as there is no Info.plist file available which is required for setting the proper window mode and such. It's therefore recommended to run the application from the installation directory for any more in-depth testing. But normal debugging can of course be done from the build directory. Running ES-DE from the build directory may be a bit flaky as there is no Info.plist file available which is required for setting the proper window mode and such. It's therefore recommended to run the application from the installation directory for any more in-depth testing. But normal debugging can of course be done from the build directory.

2
ROADMAP.md
View file

@ -36,7 +36,7 @@ A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/
* _Add GLM library dependency for matrix and vector operations, decommission the built-in functions_ * _Add GLM library dependency for matrix and vector operations, decommission the built-in functions_
* _AppImage and AUR releases on Linux_ * _AppImage and AUR releases on Linux_
#### v2.0 (in progress) #### v2.0 (in development)
* _New theme engine with generalized views (only System and Gamelist) and theme variants support_ * _New theme engine with generalized views (only System and Gamelist) and theme variants support_
* _Multiple new components (carousel support for the Gamelist view, grid component etc.)_ * _Multiple new components (carousel support for the Gamelist view, grid component etc.)_