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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-12-16 14:12:23 +01:00
parent 0887f4c092
commit 3d8b35b77e
13 changed files with 23 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CHANGELOG.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) - Changelog # ES-DE (EmulationStation Desktop Edition) - Changelog
## Version 3.0.0 (in development) ## Version 3.0.0 (in development)
@ -8,11 +8,17 @@
### Detailed list of changes ### 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 * (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 * (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 ### Bug fixes
* Font textures were sometimes updated with empty glyhps which generated OpenGL errors on some mobile GPUs
## Version 2.2.1 ## Version 2.2.1
**Release date:** 2023-11-12 **Release date:** 2023-11-12

2
CONTRIBUTING.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) - Contributing # ES-DE (EmulationStation Desktop Edition) - Contributing
### Help needed ### Help needed

7
CREDITS.md
View file

@ -1,11 +1,10 @@
# EmulationStation Desktop Edition (ES-DE) - Credits # ES-DE (EmulationStation Desktop Edition) - Credits
# Programming # Programming
**Desktop Edition**\ **ES-DE**\
Leon Styhre \ Leon Styhre \
Sophia Hadash \ Sophia Hadash
Joseph Geumlek
**RetroPie fork**\ **RetroPie fork**\
RetroPie community RetroPie community

2
FAQ.md
View file

@ -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? ## What is this project and how is it related to other EmulationStation forks?

4
INSTALL-DEV.md
View file

@ -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. 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` 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 `<name>` and `<systemsortname>` tags present per system. The structure of this file is essentially a simplified version of the es_systems.xml file, but with only the `<name>` and `<systemsortname>` tags present per system.

4
INSTALL.md
View file

@ -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: 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` 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 `<name>` and `<systemsortname>` tags present per system. The structure of this file is essentially a simplified version of the es_systems.xml file, but with only the `<name>` and `<systemsortname>` tags present per system.

2
LICENSE
View file

@ -1,4 +1,4 @@
Copyright (c) 2020-2023 Leon Styhre Copyright (c) 2020-2024 Leon Styhre
Copyright (c) 2014 Alec Lofquist Copyright (c) 2014 Alec Lofquist
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
README.md
View file

@ -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. EmulationStation Desktop Edition is a frontend for browsing and launching games from your multi-platform game collection.

2
ROADMAP.md
View file

@ -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. 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.

2
THEMES-DEV.md
View file

@ -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. **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.

2
THEMES.md
View file

@ -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. 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.

2
USERGUIDE-DEV.md
View file

@ -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. 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.

2
USERGUIDE.md
View file

@ -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. It's generally recommended to read the [Frequently Asked Questions (FAQ)](FAQ.md) document prior to diving into the information in this guide.