From 394f99898c65d4324ba4888d23798d8098fee55f Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Thu, 7 Jul 2022 18:33:35 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 3 ++- INSTALL-DEV.md | 9 ++++---- INSTALL.md | 9 ++++---- USERGUIDE-DEV.md | 55 ++++++++++++++++++++++++++++++++++++------------ USERGUIDE.md | 7 ++++++ 5 files changed, 58 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 223e639ec..128678db7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -159,6 +159,7 @@ v1.2 maintenance release. * Added experimental support for Vita3K for the psvita system on Unix and Windows * Added support for the Fujitsu FM Towns (fmtowns) game system on Unix and Windows +* Added support for the EasyRPG game engine (easyrpg) game system * Added support for the Creatronic Mega Duck (megaduck) game system * Added support for the Watara Supervision (supervision) game system * Added support for the M.U.G.E.N Game Engine (mugen) game system on Windows @@ -167,7 +168,7 @@ v1.2 maintenance release. * Added emulator configuration for the macintosh system * Added emulator configuration for the solarus system * Added Mednafen standalone as an alternative emulator for many systems -* Added experimental support for PCSX2 Qt standalone for the ps2 system on Unix +* Added PCSX2 Qt standalone as an alternative emulator for the ps2 system on Unix * Added ScummVM standalone as an alternative emulator for the scummvm system * Added Cxbx-Reloaded standalone as an alternative emulator for the xbox system on Windows * Added Atari800 standalone as an alternative emulator for the a5200 system diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index 2c09327e2..ce4dec597 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -442,10 +442,7 @@ tools/create_AppImage_SteamDeck.sh This is similar to the regular AppImage but does not build with the BUNDLED_CERTS option and changes some settings like the VRAM limit. -Both _appimagetool_ and _linuxdeploy_ are required for the build process but they will be downloaded automatically by the script if they don't exist. So to force an update to the latest build tools, delete these two AppImages prior to running the build script. Be aware though that some releases of linuxdeploy may be broken and could lead to the inclusion of invalid dependencies that will make the package unusable on some distributions. The release with the following -V output has been tested and is working correctly: -``` -linuxdeploy version 1-alpha (git commit ID 9aa59f3), GitHub actions build 41 built on 2021-11-20 01:00:04 UTC -``` +Both _appimagetool_ and _linuxdeploy_ are required for the build process but they will be downloaded automatically by the script if they don't exist. So to force an update to the latest build tools, delete these two AppImages prior to running the build script. ## Building on macOS @@ -1146,6 +1143,8 @@ The bundled es_systems.xml file is located in the resources directory that is pa It doesn't matter in which order you define the systems as they will be sorted by the `` tag or by the optional `` tag when displayed inside the application. But it's still a good idea to add the systems in alphabetical order to make the configuration file easier to maintain. +Note that the `` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011. + Wildcards are supported for emulator binaries, but not for directories: ```xml @@ -1178,7 +1177,7 @@ Below is an overview of the file layout with various examples. For the command t + be displayed anywhere within the appliction. Note that the sorting is done in lexicographic order. --> Super Nintendo @@ -1433,7 +1432,7 @@ Below is an overview of the file layout with various examples. For the command t + be displayed anywhere within the appliction. Note that the sorting is done in lexicographic order. --> Super Nintendo