mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 21:55:38 +00:00
Minor documentation update.
This commit is contained in:
Leon Styhre
parent
056394b1f1
commit
fb9576a94a
|
|
@ -1,6 +1,6 @@
|
|||
# Contributing to EmulationStation Desktop Edition (ES-DE)
|
||||
|
||||
### Help needed:
|
||||
### Help needed
|
||||
|
||||
Contributions to ES-DE are very much appreciated as there are many things that need to be implemented and improved. Code commits is only one part of it, as work is also needed on the rbsimple-DE theme set as well as thorough application testing.
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ This plan is under constant review so expect it to change from time to time. Sti
|
|||
* Complete overhaul of the grid view style
|
||||
* A nice and useful grid view implementation in rbsimple-DE
|
||||
* Better shader support (more adaptive to screen resolution, higher performance, cleaner code)
|
||||
* Improve text and font functions, e.g. faster and cleaner line wrapping
|
||||
* Improved text and font functions, e.g. faster and cleaner line wrapping
|
||||
* Flatpak and Snap support on Linux
|
||||
|
||||
#### v1.4
|
||||
|
|
@ -78,7 +78,7 @@ This plan is under constant review so expect it to change from time to time. Sti
|
|||
|
||||
To see which features have been implemented in previous versions, refer to [RELEASES.md](RELEASES.md).
|
||||
|
||||
### Coding style:
|
||||
### Coding style
|
||||
|
||||
The coding style for ES-DE is mostly a combination of the Linux kernel style (although that's C it's close enough to C++ as far as I'm concerned) and Google's C++ guidelines.
|
||||
|
||||
|
|
@ -111,6 +111,6 @@ https://google.github.io/styleguide/cppguide.html
|
|||
* Avoid overoptimizations, especially if it sacrifices readability, makes the code hard to expand on or is error prone
|
||||
* For the rest, check the code and have fun! :)
|
||||
|
||||
### Building and configuring:
|
||||
### Building and configuring
|
||||
|
||||
Please refer to [INSTALL.md](INSTALL.md) for details on everything related to building ES-DE.
|
||||
|
|
|
|||
10
INSTALL.md
10
INSTALL.md
|
|
@ -748,7 +748,7 @@ As there's no package manager in Windows and no way to handle dependencies, we n
|
|||
|
||||
Copy the files to the `emulationstation-de` build directory. Most of them will come from the packages that were provided in the previous steps of this guide.
|
||||
|
||||
MSVC:
|
||||
**Required files for MSVC:**
|
||||
```
|
||||
FreeImage.dll
|
||||
FreeImage.lib
|
||||
|
|
@ -792,7 +792,7 @@ for /f "skip=19 tokens=4" %A in (exports.txt) do echo %A >> libvlc.def
|
|||
lib /def:libvlc.def /out:libvlc.lib /machine:x64
|
||||
```
|
||||
|
||||
MinGW:
|
||||
**Required files for MinGW:**
|
||||
|
||||
```
|
||||
FreeImage.dll
|
||||
|
|
@ -809,7 +809,7 @@ SDL2.dll
|
|||
vcomp140.dll (From Visual C++ Redistributable for Visual Studio 2015, 32-bit version)
|
||||
```
|
||||
|
||||
Both MinGW and MSVC:
|
||||
**Required files for both MSVC and MinGW:**
|
||||
|
||||
In addition to the files above, you need to copy some libraries from the VLC `plugins` folder to be able to play video files. There is a subdirectory structure under the plugins folder but there is no requirement to retain this as libVLC apparently looks recursively for the .dll files.
|
||||
|
||||
|
|
@ -1260,10 +1260,10 @@ The following variables are expanded for the `command` tag:
|
|||
|
||||
`%ROM%` - Replaced with the absolute path to the selected ROM, with most Bash special characters escaped with a backslash.
|
||||
|
||||
`%BASENAME%` - Replaced with the "base" name of the path to the selected ROM. For example, a path of `/foo/bar.rom`, this tag would be `bar`. This tag is useful for setting up AdvanceMAME.
|
||||
|
||||
`%ROMRAW%` - Replaced with the unescaped, absolute path to the selected ROM. If your emulator is picky about paths, you might want to use this instead of %ROM%, but enclosed in quotes.
|
||||
|
||||
`%BASENAME%` - Replaced with the "base" name of the path to the selected ROM. For example, a path of `/foo/bar.rom`, this tag would be `bar`. This tag is useful for setting up AdvanceMAME.
|
||||
|
||||
`%EMUPATH%` - Replaced with the path to the emulator binary. This is expanded either using the PATH environmental variable of the operating system, or if an absolute emulator path is defined, this will be used instead. This variable is mostly useful to define the emulator core path for Windows, as this operating system does not have a standardized program installation directory structure.
|
||||
|
||||
`%ESPATH%` - Replaced with the path to the EmulationStation binary. Mostly useful for portable emulator installations, for example on a USB memory stick.
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -32,16 +32,16 @@ A comprehensive theme set, **rbsimple-DE** (which is based on Recalbox Multi fro
|
|||
|
||||
**_The ES-DE repository was just opened for public access and there are no binary distributions available yet. But the plan is to have Beta 1 available in the near future when most of the known bugs have been fixed. Stay tuned._**
|
||||
|
||||
| Package | Operating systems | Architecture | Version | Download link |
|
||||
| :------------------ | :---------------------------------- | :----------- | :---------- | :------------- |
|
||||
| Debian DEB package | Ubuntu, Linux Mint and similar | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| Fedora RPM package | Fedora Workstation, possibly others | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| macOS DMG installer | 10.11 "El Capitan" to 11 "Big Sur" | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| Windows installer | Windows 10 and 8.1 | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| Package | Operating systems | Architecture | Version | Download link |
|
||||
| :------------------ | :--------------------------------------- | :----------- | :---------- | :------------- |
|
||||
| Debian DEB package | Ubuntu, Linux Mint and similar | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| Fedora RPM package | Fedora Workstation, possibly others | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| macOS DMG installer | macOS 10.11 "El Capitan" to 11 "Big Sur" | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
| Windows installer | Windows 10 and 8.1 | x64 (x86) | 1.0.0-beta1 | Available soon |
|
||||
|
||||
For some of the rarer operating systems listed at the top you need to build ES-DE from source. The plan is to have ES-DE available in the software repositories of all supported operating systems (where this is applicable), so in the long term building from source should not be required.
|
||||
|
||||
**Note:** The software is currently in beta status which means it's also beta quality and may contain bugs. The application should still (hopefully) be good enough for every day use and bugs will be fixed continuously.
|
||||
**Note:** The software is currently in beta status which means it's also beta quality and may contain bugs. The application should still hopefully be good enough for every day use and bugs will be fixed continuously.
|
||||
|
||||
|
||||
### Contributing
|
||||
|
|
|
|||
|
|
@ -75,11 +75,13 @@ Many bugs have been fixed, and numerous features that were only partially implem
|
|||
* All required fonts bundled with the application, no dependencies on the OS to provide them any longer
|
||||
* Made pugixml an external dependency instead of bundling it
|
||||
* Replaced the custom math functions with standard C++ functions whenever possible
|
||||
* Implemented proper random functions using Mersenne Twister pseudorandom number generators (believe me, it makes a practical difference)
|
||||
* Modernized the audio code, for example using SDL_AudioStream instead of the older SDL_AudioCVT
|
||||
* Overhaul of application settings, now the configuration file is only updated when there have been actual configuration changes
|
||||
* Decreased CPU usage dramatically by only rendering the currently visible view (previously all views were always rendered)
|
||||
* Updated the CMake/CPack install and package configuration files to work as expected (can now generate DEB, RPM, DMG and NSIS installation packages with correct dependencies)
|
||||
* Added support for Clang/LLVM, made the application build with no errors or warnings using this compiler (Unix and macOS only)
|
||||
* Added support for both MSVC and MinGW (GCC) on Windows
|
||||
* License files included for all the libraries and resources that are bundled with the application
|
||||
* Updated the MAME ROM index files to include ROMs up to MAME version 0.226 and created scripts to easily generate these index files in the future
|
||||
* Greatly expanded the application documentation (which is hosted in the ES-DE repository on GitLab)
|
||||
|
|
@ -89,7 +91,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
|
|||
* On Unix, adding a hidden folder with a game in it crashed the application on startup
|
||||
* If the user tried to enter a blank game name in the metadata editor, the application would crash upon saving
|
||||
* Switching to the Grid view style with a placeholder shown in the gamelist crashed the application
|
||||
* FileSystemUtil::getDirContent() crashed when searching through directories recursively
|
||||
* FileSystemUtil::getDirContent crashed when searching through directories recursively
|
||||
* Fixed a massive memory leak related to SVG images
|
||||
* Fixed an issue where SVG images would sometimes be cut off slightly on the right side (e.g. logos on the system view carousel)
|
||||
* The scraper didn't handle error conditions correctly
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
# Missing systems
|
||||
|
||||
None at the moment.
|
||||
|
||||
# Missing (or not updated) theme data
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue