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 2021-10-06 19:15:33 +02:00
parent 019c764d93
commit 2bd4c163b1
2 changed files with 12 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -23,6 +23,7 @@
* Lowered the minimum supported screen resolution from 640x480 to 224x224 to support arcade cabinet displays such as those running at 384x224 and 224x384 * Lowered the minimum supported screen resolution from 640x480 to 224x224 to support arcade cabinet displays such as those running at 384x224 and 224x384
* Expanded the themeable options for "helpsystem" to support custom button graphics, dimmed text and icon colors, upper/lower/camel case and custom spacing * Expanded the themeable options for "helpsystem" to support custom button graphics, dimmed text and icon colors, upper/lower/camel case and custom spacing
* Made the scrolling speed of ScrollableContainer more consistent across various screen resolutions and display aspect ratios * Made the scrolling speed of ScrollableContainer more consistent across various screen resolutions and display aspect ratios
* Made the game name and description stop scrolling when running the media viewer, the screensaver or when running in the background while a game is launched
* Added support for using the left and right trigger buttons in the help prompts * Added support for using the left and right trigger buttons in the help prompts
* Removed the "Choose" entry from the help prompts in the gamelist view * Removed the "Choose" entry from the help prompts in the gamelist view
* Changed the "Toggle screensaver" help entry in the system view to simply "Screensaver" * Changed the "Toggle screensaver" help entry in the system view to simply "Screensaver"
@ -38,6 +39,7 @@
* Added support for a new type of "flat style" button to ButtonComponent * Added support for a new type of "flat style" button to ButtonComponent
* Added support for correctly navigating arbitrarily sized ComponentGrid entries, i.e. those spanning multiple cells * Added support for correctly navigating arbitrarily sized ComponentGrid entries, i.e. those spanning multiple cells
* Bundled the bold font version of Fontfabric Akrobat * Bundled the bold font version of Fontfabric Akrobat
* Added RapidJSON as a Git subtree
* Added the GLM (OpenGL Mathematics) library as a Git subtree * Added the GLM (OpenGL Mathematics) library as a Git subtree
* Replaced all built-in matrix and vector data types and functions with GLM library equivalents * Replaced all built-in matrix and vector data types and functions with GLM library equivalents
* Replaced some additional math functions and moved the remaining built-in functions to a math utility namespace * Replaced some additional math functions and moved the remaining built-in functions to a math utility namespace
@ -59,6 +61,8 @@
* When scraping in interactive mode, "No games found" results could be accepted using the "A" button * When scraping in interactive mode, "No games found" results could be accepted using the "A" button
* When scraping in interactive mode, any refining done using the "Y" button shortcut would not be shown when doing another refine using the "Refine search" button * When scraping in interactive mode, any refining done using the "Y" button shortcut would not be shown when doing another refine using the "Refine search" button
* Under some circumstances ScrollableContainer (used for the game descriptions) would contain a partially rendered bottom line * Under some circumstances ScrollableContainer (used for the game descriptions) would contain a partially rendered bottom line
* If the TextListComponent height was not evenly dividable by the font height + line spacing, a partial bottom row would get rendered
* The line spacing for TextListComponent was incorrectly calculated for some resolutions such as 2560x1440
* Removing games from custom collections did not remove their filter index entries * Removing games from custom collections did not remove their filter index entries
* Input consisting of only whitespace characters would get accepted by TextEditComponent which led to various strange behaviors * Input consisting of only whitespace characters would get accepted by TextEditComponent which led to various strange behaviors
* Leading and trailing whitespace characters would not get trimmed from the collection name when creating a new custom collection * Leading and trailing whitespace characters would not get trimmed from the collection name when creating a new custom collection

39
INSTALL-DEV.md
View file

@ -27,7 +27,7 @@ There are some dependencies that need to be fulfilled in order to build ES-DE. T
All of the required packages can be installed with apt-get: All of the required packages can be installed with apt-get:
``` ```
sudo apt-get install build-essential clang-format git cmake libsdl2-dev libavcodec-dev libavfilter-dev libavformat-dev libavutil-dev libfreeimage-dev libfreetype6-dev libcurl4-openssl-dev libpugixml-dev rapidjson-dev libasound2-dev libgl1-mesa-dev sudo apt-get install build-essential clang-format git cmake libsdl2-dev libavcodec-dev libavfilter-dev libavformat-dev libavutil-dev libfreeimage-dev libfreetype6-dev libcurl4-openssl-dev libpugixml-dev libasound2-dev libgl1-mesa-dev
``` ```
If building with the optional VLC video player, the following packages are also needed: If building with the optional VLC video player, the following packages are also needed:
@ -39,7 +39,7 @@ sudo apt-get install vlc libvlc-dev
Use dnf to install all the required packages: Use dnf to install all the required packages:
``` ```
sudo dnf install gcc-c++ clang-tools-extra cmake SDL2-devel ffmpeg-devel freeimage-devel freetype-devel curl-devel pugixml-devel rapidjson-devel alsa-lib-devel mesa-libGL-devel sudo dnf install gcc-c++ clang-tools-extra cmake SDL2-devel ffmpeg-devel freeimage-devel freetype-devel curl-devel pugixml-devel alsa-lib-devel mesa-libGL-devel
``` ```
If building with the VLC video player, add the RPM Fusion repository. If building with the VLC video player, add the RPM Fusion repository.
@ -56,7 +56,7 @@ sudo dnf install vlc vlc-devel
Use pacman to install all the required packages: Use pacman to install all the required packages:
``` ```
sudo pacman -S gcc clang make cmake pkgconf sdl2 ffmpeg freeimage freetype2 pugixml rapidjson sudo pacman -S gcc clang make cmake pkgconf sdl2 ffmpeg freeimage freetype2 pugixml
``` ```
If building with the optional VLC video player, the following package is also needed: If building with the optional VLC video player, the following package is also needed:
@ -70,7 +70,7 @@ Note: The Raspberry Pi 4 is the minimum recommended model to use with ES-DE. As
All of the required packages can be installed with apt-get: 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 sudo apt-get install clang-format cmake libsdl2-dev libavcodec-dev libavfilter-dev libavformat-dev libavutil-dev libfreeimage-dev libcurl4-gnutls-dev libpugixml-dev
``` ```
If building with the optional VLC video player, the following packages are also needed: If building with the optional VLC video player, the following packages are also needed:
@ -87,7 +87,7 @@ sudo apt-get install libcec-dev libp8-platform-dev
Use pkg to install the dependencies: Use pkg to install the dependencies:
``` ```
pkg install git pkgconf cmake sdl2 ffmpeg freeimage pugixml rapidjson pkg install git pkgconf cmake sdl2 ffmpeg freeimage pugixml
``` ```
If building with the optional VLC video player, the following package is also needed: If building with the optional VLC video player, the following package is also needed:
@ -101,7 +101,7 @@ Clang/LLVM and cURL should already be included in the base OS installation.
Use pkgin to install the dependencies: Use pkgin to install the dependencies:
``` ```
pkgin install clang git cmake pkgconf SDL2 ffmpeg4 freeimage pugixml rapidjson pkgin install clang git cmake pkgconf SDL2 ffmpeg4 freeimage pugixml
``` ```
If building with the optional VLC video player, the following package is also needed: If building with the optional VLC video player, the following package is also needed:
@ -125,16 +125,6 @@ pkg_add vlc
In the same manner as for FreeBSD, Clang/LLVM and cURL should already be installed by default. In the same manner as for FreeBSD, Clang/LLVM and cURL should already be installed by default.
RapidJSON is not part of the OpenBSD ports/package collection as of v6.8, so you need to compile it yourself. At the time of writing, the latest release v1.1.0 does not compile on OpenBSD, so you need to use the latest available code from the master branch:
```
git clone https://github.com/Tencent/rapidjson.git
cd rapidjson
cmake .
make
make install
```
Pugixml does exist in the package collection but somehow this version is not properly detected by CMake, so you need to compile this manually as well: Pugixml does exist in the package collection but somehow this version is not properly detected by CMake, so you need to compile this manually as well:
``` ```
@ -440,7 +430,7 @@ Be aware that Homebrew can be really slow, especially when it compiles packages
Install the required tools and dependencies: Install the required tools and dependencies:
``` ```
brew install clang-format cmake pkg-config nasm fdk-aac libvpx sdl2 freeimage freetype pugixml rapidjson brew install clang-format cmake pkg-config nasm fdk-aac libvpx sdl2 freeimage freetype pugixml
``` ```
If building with the optional VLC video player, then run this as well: If building with the optional VLC video player, then run this as well:
@ -870,18 +860,6 @@ cmake -G "MinGW Makefiles" -DBUILD_SHARED_LIBS=ON .
make make
``` ```
[RapidJSON](http://rapidjson.org)
For RapidJSON you don't need to compile anything, you just need the include files.
At the time of writing, the latest release v1.1.0 generates some compiler warnings on Windows, but this can be avoided by using the latest available code from the master branch:
```
git clone git://github.com/Tencent/rapidjson.git
```
**Clone the ES-DE repository:** **Clone the ES-DE repository:**
This works the same as on Unix or macOS, just run the following: This works the same as on Unix or macOS, just run the following:
@ -903,7 +881,7 @@ As there is no standardized include directory structure in Windows, you need to
Make a directory in your build environment tree, for instance under `C:\Programming\include` Make a directory in your build environment tree, for instance under `C:\Programming\include`
Copy the include files for cURL, FFmpeg, FreeImage, FreeType, GLEW, pugixml, RapidJSON, SDL2 and optionally VLC to this directory. Copy the include files for cURL, FFmpeg, FreeImage, FreeType, GLEW, pugixml, SDL2 and optionally VLC to this directory.
You may need to create the SDL2 directory manually and copy the header files there. You may need to create the SDL2 directory manually and copy the header files there.
@ -924,7 +902,6 @@ libavformat/
libavutil/ libavutil/
pugiconfig.hpp pugiconfig.hpp
pugixml.hpp pugixml.hpp
rapidjson/
SDL2/ SDL2/
vlc/ (only if building with the VLC video player) vlc/ (only if building with the VLC video player)
``` ```