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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-05-19 19:29:21 +02:00
parent e6653bc239
commit 66d8e2b1cc
3 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -1,6 +1,6 @@
# ES-DE Frontend - Changelog # ES-DE Frontend - Changelog
## Version 3.0.3 (in development) ## Version 3.0.3 / 3.0.3-xx (in development)
**Release date:** TBD **Release date:** TBD
@ -8,6 +8,7 @@
### Detailed list of changes ### Detailed list of changes
* (Linux) Added a DEINIT_ON_LAUNCH build flag to support KMS/direct framebuffer access
* (Linux, macOS and Windows) Added support for the new Lime3DS binary names * (Linux, macOS and Windows) Added support for the new Lime3DS binary names
* (Linux) Added support for the Flatpak release of Lime3DS * (Linux) Added support for the Flatpak release of Lime3DS
* (Android) Added support for the Emerson Arcadia 2001 (arcadia) game system * (Android) Added support for the Emerson Arcadia 2001 (arcadia) game system

8
INSTALL-DEV.md
View file

@ -135,6 +135,14 @@ make
Note that the application updater is always disabled when building for the AUR, RetroDECK, Raspberry Pi or BSD Unix. Note that the application updater is always disabled when building for the AUR, RetroDECK, Raspberry Pi or BSD Unix.
On Linux specifically you can build with the DEINIT_ON_LAUNCH option which will deinit the renderer, application window and audio support when an emulator is launched. This makes it possible to use ES-DE with KMS/direct framebuffer access to for example make ES-DE a drop-in replacement for RetroPie Emulationstation:
```
cmake -DDEINIT_ON_LAUNCH=on .
make
```
When this flag is enabled the menu option _Run in background (while game is launched)_ in the Other settings menu is removed and all functionality related to running ES-DE in the background is also disabled.
By default the master branch will be used, which is where development takes place. To instead build a stable release, switch to the `stable-x.x` branch for the version, for example: By default the master branch will be used, which is where development takes place. To instead build a stable release, switch to the `stable-x.x` branch for the version, for example:
``` ```

4
USERGUIDE-DEV.md
View file

@ -302,9 +302,9 @@ The Android port of ES-DE is quite different than the other versions, so it has
## Specific notes for Raspberry Pi ## Specific notes for Raspberry Pi
ES-DE on the Raspberry Pi requires a desktop environment, or more specifically a window manager and a sound server (like PulseAudio or PipeWire). There are no plans to add support for direct hardware access to the framebuffer or to ALSA. If you want to use your Raspberry Pi as an appliance, take a look at [RetroPie](https://retropie.org.uk), [Recalbox](https://www.recalbox.com) or [Batocera](https://batocera.org) instead. By default ES-DE on the Raspberry Pi requires a desktop environment to run, or more specifically a window manager and a sound server (like PulseAudio or PipeWire). It is however possible to use KMS/direct framebuffer access if the DEINIT_ON_LAUNCH flag is used when building ES-DE, as documented in the _Building on Unix_ section of the [INSTALL-DEV.md](INSTALL-DEV.md#building-on-unix) document.
Also note that there are no prebuilt packages for the Raspberry Pi, so you will need to compile ES-DE yourself. Fortunately this is easy to do and the process is documented [here](INSTALL-DEV.md#building-on-unix). Note that there are no prebuilt packages for the Raspberry Pi, so you will need to compile ES-DE yourself. Fortunately this is easy to do and the process is documented [here](INSTALL-DEV.md#building-on-unix).
The Raspberry Pi 4/400 is the minimum recommended version and earlier boards have not been tested. The Raspberry Pi 4/400 is the minimum recommended version and earlier boards have not been tested.