From 3d8b35b77e125501c9768b2226b8ab9c109b45a2 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sat, 16 Dec 2023 14:12:23 +0100 Subject: [PATCH] Documentation update --- CHANGELOG.md | 8 +++++++- CONTRIBUTING.md | 2 +- CREDITS.md | 7 +++---- FAQ.md | 2 +- INSTALL-DEV.md | 4 ++-- INSTALL.md | 4 ++-- LICENSE | 2 +- README.md | 2 +- ROADMAP.md | 2 +- THEMES-DEV.md | 2 +- THEMES.md | 2 +- USERGUIDE-DEV.md | 2 +- USERGUIDE.md | 2 +- 13 files changed, 23 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 64d5ffaae..8f0d62698 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) - Changelog +# ES-DE (EmulationStation Desktop Edition) - Changelog ## Version 3.0.0 (in development) @@ -8,11 +8,17 @@ ### Detailed list of changes +* Renamed the application from EmulationStation Desktop Edition to ES-DE +* Renamed the application data directory from .emulationstation to ES-DE * (Unix) Removed the -Minimized flag from the Visual Pinball launch command * (Windows) Updated the find rules for Visual Pinball to match the actual filenames of the official releases +* Added workarounds for some mobile GPUs which do not support all OpenGL operations when using the BGRA pixel format +* Replaced a number of homecooked functions in FileSystemUtil with those from the C++ Standard Library ### Bug fixes +* Font textures were sometimes updated with empty glyhps which generated OpenGL errors on some mobile GPUs + ## Version 2.2.1 **Release date:** 2023-11-12 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66fd2d33d..aeeb03431 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) - Contributing +# ES-DE (EmulationStation Desktop Edition) - Contributing ### Help needed diff --git a/CREDITS.md b/CREDITS.md index 60df4ea0a..32c64c72f 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,11 +1,10 @@ -# EmulationStation Desktop Edition (ES-DE) - Credits +# ES-DE (EmulationStation Desktop Edition) - Credits # Programming -**Desktop Edition**\ +**ES-DE**\ Leon Styhre \ -Sophia Hadash \ -Joseph Geumlek +Sophia Hadash **RetroPie fork**\ RetroPie community diff --git a/FAQ.md b/FAQ.md index f97782154..922d4a0c6 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) - Frequently Asked Questions +# ES-DE (EmulationStation Desktop Edition) - Frequently Asked Questions ## What is this project and how is it related to other EmulationStation forks? diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index 2ae95beda..0709f81d2 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v3.0 (development version) - Building and advanced configuration +# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - Building and advanced configuration This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [INSTALL.md](INSTALL.md) instead. @@ -1468,7 +1468,7 @@ Here is yet another example with the addition of the `snes` system where some fi This file makes it possible to apply a custom systems sorting without having to modify the es_systems.xml file directly. It should be placed in the custom_systems directory, e.g. `~/.emulationstation/custom_systems/es_systems_sorting.xml` -Note that in order for ES-DE to load this file you'll need to set the _Systems sorting_ option in the _Other settings_ menu to _Full names or custom_. +Note that in order for ES-DE to load this file you'll need to set the _Systems sorting_ option in the _UI settings_ menu to _Full names or custom_. The structure of this file is essentially a simplified version of the es_systems.xml file, but with only the `` and `` tags present per system. diff --git a/INSTALL.md b/INSTALL.md index ab1ec48a2..31967beed 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v2.2 - Building and advanced configuration +# ES-DE (EmulationStation Desktop Edition) v2.2 - Building and advanced configuration Table of contents: @@ -1466,7 +1466,7 @@ Here is yet another example with the addition of the `snes` system where some fi This file makes it possible to apply a custom systems sorting without having to modify the es_systems.xml file directly. It should be placed in the custom_systems directory, e.g. `~/.emulationstation/custom_systems/es_systems_sorting.xml` -Note that in order for ES-DE to load this file you'll need to set the _Systems sorting_ option in the _Other settings_ menu to _Full names or custom_. +Note that in order for ES-DE to load this file you'll need to set the _Systems sorting_ option in the _UI settings_ menu to _Full names or custom_. The structure of this file is essentially a simplified version of the es_systems.xml file, but with only the `` and `` tags present per system. diff --git a/LICENSE b/LICENSE index 5f27c157e..84a609b0d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2020-2023 Leon Styhre +Copyright (c) 2020-2024 Leon Styhre Copyright (c) 2014 Alec Lofquist Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index f5dbb1713..6f207fde1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) +# ES-DE (EmulationStation Desktop Edition) EmulationStation Desktop Edition is a frontend for browsing and launching games from your multi-platform game collection. diff --git a/ROADMAP.md b/ROADMAP.md index 6e6584f42..6f2898e06 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) - Feature roadmap +# ES-DE (EmulationStation Desktop Edition) - Feature roadmap ES-DE is developed using an agile methodology so which features to include per release is reviewed and adjusted continuously. As such this document is basically a list of the main features that are planned to be added eventually. diff --git a/THEMES-DEV.md b/THEMES-DEV.md index 18491cf6a..90c4aeaea 100644 --- a/THEMES-DEV.md +++ b/THEMES-DEV.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v3.0 (development version) - Themes +# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - Themes **Note:** This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [THEMES.md](THEMES.md) instead. diff --git a/THEMES.md b/THEMES.md index 8cff60738..cf73cd044 100644 --- a/THEMES.md +++ b/THEMES.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v2.2 - Themes +# ES-DE (EmulationStation Desktop Edition) v2.2 - Themes If creating themes specifically for ES-DE, please add `-es-de` to the repository/directory name, as in `slate-es-de`. Themes made for ES-DE are not compatible with any other EmulationStation forks (and vice versa) and the -es-de extension makes it clear that it's an ES-DE theme. The actual theme name as defined using the `themeName` tag in capabilities.xml does of course not need to include the `-es-de` extension as that's the actual theme name that will be displayed when selecting themes from the _UI Settings_ menu. For example slate-es-de will be listed simply as _Slate_ in this menu. diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 0b5543f0c..4d5dbc2a1 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v3.0 (development version) - User guide +# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - User guide This version of the user guide is only relevant for the current ES-DE development version, if you are using the latest stable release, refer to [USERGUIDE.md](USERGUIDE.md) instead. diff --git a/USERGUIDE.md b/USERGUIDE.md index 63d1276c9..2179da9cc 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v2.2 - User guide +# ES-DE (EmulationStation Desktop Edition) v2.2 - User guide It's generally recommended to read the [Frequently Asked Questions (FAQ)](FAQ.md) document prior to diving into the information in this guide.