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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2021-07-09 22:04:16 +02:00
parent 6a7eb982f2
commit 717eb98a6e
4 changed files with 44 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -73,9 +73,12 @@ Apart from this, many small improvements and bug fixes are part of the release,
* Added the CImg library as a Git subtree and created some utility functions for it (used by the miximage generator and the game launch screen) * Added the CImg library as a Git subtree and created some utility functions for it (used by the miximage generator and the game launch screen)
* Added a function to ImageComponent to crop fully transparent areas around an image * Added a function to ImageComponent to crop fully transparent areas around an image
* Added a CMake option to control whether the VLC video player should be built, and set this to off by default * Added a CMake option to control whether the VLC video player should be built, and set this to off by default
* Made it possible to build on the Raspberry Pi 4 (Raspberry Pi OS)
* Removed the deprecated VideoOmxComponent
* Removed the pointless APPLE_SKIP_INSTALL_LIBS CMake option * Removed the pointless APPLE_SKIP_INSTALL_LIBS CMake option
* Added a clang-format style configuration file to use for automatic code formatting * Added a clang-format style configuration file to use for automatic code formatting
* Formatted the entire codebase using clang-format * Formatted the entire codebase using clang-format
* Integrated clang-tidy with CMake and made it possible to enable it via a flag
* Added the NanoSVG library as a proper Git subtree * Added the NanoSVG library as a proper Git subtree
* Changed the language standard from C++11 to C++14 * Changed the language standard from C++11 to C++14
@ -96,6 +99,7 @@ Apart from this, many small improvements and bug fixes are part of the release,
* The Quick System Select help prompt was shown even when there was only a single game system present * The Quick System Select help prompt was shown even when there was only a single game system present
* The "Back (cancel)" help prompt was missing for the single-game scraper * The "Back (cancel)" help prompt was missing for the single-game scraper
* The "Y" button help prompt wasn't displayed correctly when using the Grid view style * The "Y" button help prompt wasn't displayed correctly when using the Grid view style
* Fractional game rating values would always get rounded up
* Encountering a corrupt image file would lead to a continuous loop of attempts to load the image while filling the log file with error messages * Encountering a corrupt image file would lead to a continuous loop of attempts to load the image while filling the log file with error messages
* Cropping in ImageComponent didn't work correctly * Cropping in ImageComponent didn't work correctly
* The debug logging for the analog controller inputs had some inconsistent signs * The debug logging for the analog controller inputs had some inconsistent signs

2
CREDITS.md
View file

@ -2,7 +2,7 @@
# Programming # Programming
Alec "Aloshi" Lofquist (original version) \ Alec Lofquist (original version) \
http://www.aloshi.com http://www.aloshi.com
RetroPie Community (RetroPie fork) \ RetroPie Community (RetroPie fork) \

52
INSTALL-DEV.md
View file

@ -14,7 +14,7 @@ ES-DE is developed and compiled using Clang/LLVM and GCC on Unix, Clang/LLVM on
CMake is the build system for all the supported operating systems, used in conjunction with `make` on Unix and macOS and `nmake` and `make` on Windows. Xcode on macOS or Visual Studio on Windows are not required for building ES-DE and they have not been used during the development. The only exception is notarization of codesigned macOS packages which require the `altool` and `stapler` binaries that come bundled with Xcode. CMake is the build system for all the supported operating systems, used in conjunction with `make` on Unix and macOS and `nmake` and `make` on Windows. Xcode on macOS or Visual Studio on Windows are not required for building ES-DE and they have not been used during the development. The only exception is notarization of codesigned macOS packages which require the `altool` and `stapler` binaries that come bundled with Xcode.
For automatic code formatting clang-format is used. For automatic code formatting [clang-format](https://clang.llvm.org/docs/ClangFormat.html) is used.
Any code editor can be used of course, but I recommend [VSCode](https://code.visualstudio.com). Any code editor can be used of course, but I recommend [VSCode](https://code.visualstudio.com).
@ -25,7 +25,7 @@ The code has some dependencies. For building, you'll need CMake and development
**Installing dependencies:** **Installing dependencies:**
**On Debian/Ubuntu** **Debian/Ubuntu**
All of the required packages can be installed with apt-get: All of the required packages can be installed with apt-get:
``` ```
@ -37,7 +37,7 @@ If building with the optional VLC video player, the following packages are also
sudo apt-get install vlc libvlc-dev sudo apt-get install vlc libvlc-dev
``` ```
**On Fedora** **Fedora**
Use dnf to install all the required packages: Use dnf to install all the required packages:
``` ```
@ -53,7 +53,7 @@ sudo dnf install ./rpmfusion-free-release-33.noarch.rpm
sudo dnf install vlc vlc-devel sudo dnf install vlc vlc-devel
``` ```
**On Manjaro** **Manjaro**
Use pacman to install all the required packages: Use pacman to install all the required packages:
@ -66,7 +66,26 @@ If building with the optional VLC video player, the following package is also ne
sudo pacman -S vlc sudo pacman -S vlc
``` ```
**On FreeBSD** **Raspberry Pi OS (Raspian)**
Note: The Raspberry Pi 4 is the minimum recommended model to use with ES-DE. As this type of device is quite weak and because the FFmpeg video player currently lacks hardware decoding/acceleration it is strongly adviced to build with the VLC player, which is hardware accelerated.
All of the required packages can be installed with apt-get:
```
sudo apt-get install clang-format cmake libsdl2-dev libavcodec-dev libavfilter-dev libavformat-dev libavutil-dev libfreeimage-dev libcurl4-gnutls-dev libpugixml-dev rapidjson-dev
```
If building with the optional VLC video player, the following packages are also needed:
```
sudo apt-get install vlc libvlc-dev
```
To build with CEC support you also need to install these packages:
```
sudo apt-get install libcec-dev libp8-platform-dev
```
**FreeBSD**
Use pkg to install the dependencies: Use pkg to install the dependencies:
``` ```
@ -80,7 +99,7 @@ pkg install vlc
Clang/LLVM and cURL should already be installed in the base OS image. Clang/LLVM and cURL should already be installed in the base OS image.
**On NetBSD** **NetBSD**
Use pkgin to install the dependencies: Use pkgin to install the dependencies:
``` ```
@ -94,7 +113,7 @@ pkgin vlc
NetBSD ships with GCC by default, and although you should be able to use Clang/LLVM, it's probably easier to just stick to the default compiler environment. The reason why the clang package needs to be installed is to get clang-format onto the system. NetBSD ships with GCC by default, and although you should be able to use Clang/LLVM, it's probably easier to just stick to the default compiler environment. The reason why the clang package needs to be installed is to get clang-format onto the system.
**On OpenBSD** **OpenBSD**
Use pkg_add to install the dependencies: Use pkg_add to install the dependencies:
``` ```
@ -209,7 +228,14 @@ scan-build cmake -DCMAKE_BUILD_TYPE=Debug .
scan-build make -j6 scan-build make -j6
``` ```
You open the report with the `scan-view` command which lets you browse it using your web browser. Note that the compilation time is much higher when using the static analyzer compared to a normal compilation. As well this tool generates a lot of extra files and folders in the build tree, so it may make sense to run it in a separate copy of the source folder to avoid having to clean up all this extra data when the analysis has been completed. You open the report with the `scan-view` command which lets you browse it using your web browser. Note that the compilation time is much longer when using the static analyzer compared to a normal build. As well this tool generates a lot of extra files and folders in the build tree, so it may make sense to run it in a separate copy of the source folder to avoid having to clean up all this extra data when the analysis has been completed.
An even more advanced static analyzer is `clang-tidy`, to use it first make sure it's installed on your system and then run the following:
```
cmake -DCLANG_TIDY=on .
```
Even though many irrelevant checks are filtered out via the configuration, this will still likely produce a quite huge report (at least until most of the recommendations have been implemented). In the same manner as for scan-view, the compilation time is much longer when using this static analyzer compared to a normal build.
To build ES-DE with CEC support, enable the corresponding option, for example: To build ES-DE with CEC support, enable the corresponding option, for example:
@ -217,14 +243,14 @@ To build ES-DE with CEC support, enable the corresponding option, for example:
cmake -DCMAKE_BUILD_TYPE=Debug -DCEC=on . cmake -DCMAKE_BUILD_TYPE=Debug -DCEC=on .
make make
``` ```
I have however not been able to test the CEC support and I'm not entirely sure how it's supposed to work. You will most likely need to install additional packages to get this to build. On Debian-based systems these are _libcec-dev_ and _libp8-platform-dev_. Note that the CEC support is currently untested.
To build with the GLES renderer, run the following: To build with the GLES renderer, run the following:
``` ```
cmake -DCMAKE_BUILD_TYPE=Debug -DGLES=on . cmake -DCMAKE_BUILD_TYPE=Debug -DGLES=on .
make make
``` ```
Note that the GLES renderer is quite limited as there is no shader support for it, so ES-DE will definitely not look as pretty as when using the default OpenGL renderer. The GLES renderer is quite limited as there is no shader support for it, so ES-DE will definitely not look as pretty as when using the default OpenGL renderer. When building on a Raspberry Pi, the GLES renderer will be automatically selected.
Running multiple compile jobs in parallel is a good thing as it speeds up the build time a lot (scaling almost linearly). Here's an example telling make to run 6 parallel jobs: Running multiple compile jobs in parallel is a good thing as it speeds up the build time a lot (scaling almost linearly). Here's an example telling make to run 6 parallel jobs:
@ -265,7 +291,7 @@ This Clang debug build is LLVM "native", i.e. intended to be debugged using the
It's possible to activate the additional debug info needed by GDB by using the flag `-D_GLIBCXX_DEBUG`. I've added this to CMakeLists.txt when using Clang, but this bloats the binary and makes the code much slower. Actually, instead of a 4% faster application startup, it's now 25% slower. The same goes for the binary size, instead of 31% smaller it's now 5% larger. The compilation time is still less than GCC but only by 10% instead of 25%. It's possible to activate the additional debug info needed by GDB by using the flag `-D_GLIBCXX_DEBUG`. I've added this to CMakeLists.txt when using Clang, but this bloats the binary and makes the code much slower. Actually, instead of a 4% faster application startup, it's now 25% slower. The same goes for the binary size, instead of 31% smaller it's now 5% larger. The compilation time is still less than GCC but only by 10% instead of 25%.
I'm expecting this to be resolved in the near future though, and as I think Clang has the best error messages and comes with good tools such as the static analyzer, this is now my primary compiler. But I'm expecting this issue to be resolved in the near future so the workaround can be removed.
It's by the way very easy to switch between LLVM and GCC using Ubuntu, just use the `update-alternatives` command: It's by the way very easy to switch between LLVM and GCC using Ubuntu, just use the `update-alternatives` command:
@ -1149,9 +1175,7 @@ So the home directory will always take precedence, and any resources or themes l
The entire ES-DE codebase is formatted using clang-format and all code commits must have been processed using this tool. The entire ES-DE codebase is formatted using clang-format and all code commits must have been processed using this tool.
There is a style configuration file named .clang-format located directly at the root of the repository which contains the formatting rules. There is a style configuration file named .clang-format located directly at the root of the repository which contains the formatting rules. How to install clang-format is detailed per operating system earlier in this document.
How to install clang-format is detailed per operating system earlier in this document.
There are two ways to run the tool, from the command line or from inside an editor such as VSCode. There are two ways to run the tool, from the command line or from inside an editor such as VSCode.

2
README.md
View file

@ -31,7 +31,7 @@ The following operating systems have been tested with ES-DE (all for the x86 arc
**Note:** If using a Mac with an ARM CPU (e.g. M1) you need to install the x86 version of RetroArch and any other emulators, or you won't be able to launch any games. This will be fixed whenever a native macOS ARM build of ES-DE is released. **Note:** If using a Mac with an ARM CPU (e.g. M1) you need to install the x86 version of RetroArch and any other emulators, or you won't be able to launch any games. This will be fixed whenever a native macOS ARM build of ES-DE is released.
At the moment Raspberry Pi is not supported, but this is planned for version 1.2. It may still be possible to compile and run ES-DE on this type of device, but as of v1.1 it's not actively used during development and therefore not tested. The Raspberry Pi 4 has been tested as well (with Raspberry Pi OS) but it's a bit buggy at the moment and is missing some features like GLSL shaders. Official support will probably be added for this device as of ES-DE v1.2.
### Download ### Download