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

Some small adjustments to the information and documentation files.

Browse source
This commit is contained in:
Leon Styhre 2020-06-14 13:16:51 +02:00
parent 9f7d1c75c7
commit b7b4a851d3
6 changed files with 68 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
CREDITS.md
View file

@ -1,11 +1,11 @@
# Credits
Programming Programming
=========== ===========
Alec "Aloshi" Lofquist (original version) http://www.aloshi.com Alec "Aloshi" Lofquist (original version)\
RetroPie Community (RetroPie fork) https://retropie.org.uk http://www.aloshi.com\
Leon Styhre (Desktop Edition fork) RetroPie Community (RetroPie fork)\
https://retropie.org.uk\
Leon Styhre (Desktop Edition fork)\
UI Art & Design UI Art & Design
@ -17,36 +17,57 @@ Nils Bonenberger
Libraries Libraries
========= =========
cURL http://curl.haxx.se cURL
http://curl.haxx.se
FreeType http://www.freetype.org FreeType
http://www.freetype.org
FreeImage http://www.freeimage.sourceforge.net FreeImage
http://www.freeimage.sourceforge.net
libVLC https://wiki.videolan.org/LibVLC libVLC
https://wiki.videolan.org/LibVLC
nanosvg https://github.com/memononen/nanosvg nanosvg
https://github.com/memononen/nanosvg
pugixml http://pugixml.org pugixml
http://pugixml.org
RapdidJSON http://rapidjson.org RapdidJSON
http://rapidjson.org
SDL 2 http://www.libsdl.org SDL 2
http://www.libsdl.org
Resources Resources
========= =========
DejaVu font https://dejavu-fonts.github.io DejaVu font
https://dejavu-fonts.github.io
DroidSans FallBackFull font https://android.googlesource.com/platform/frameworks/base DroidSans font
https://android.googlesource.com/platform/frameworks/base
Font Awesome https://fontawesome.com Font Awesome
https://fontawesome.com
GNU FreeFont https://www.gnu.org/software/freefont GNU FreeFont
https://www.gnu.org/software/freefont
Nanum font https://hangeul.naver.com Nanum font
https://hangeul.naver.com
Open Sans font https://fonts.google.com/specimen/Open+Sans Open Sans font
https://fonts.google.com/specimen/Open+Sans
MAME ROM information https://www.mamedev.org MAME ROM information
https://www.mamedev.org
Licenses
========
Please find the individual license files inside the LICENSES directory.

13
DEVNOTES.md
View file

@ -1,10 +1,10 @@
Coding Style Guide Coding Style Guide
================== ==================
The coding style is mostly a combination the Linux Kernel and Google C++ coding styles. The coding style is mostly a combination the Linux Kernel and Google C++ coding styles.\
Please refer to these guides here: Please refer to these guides here:\
https://www.kernel.org/doc/html/v4.10/process/coding-style.html https://www.kernel.org/doc/html/v4.10/process/coding-style.html\
https://google.github.io/styleguide/cppguide.html https://google.github.io/styleguide/cppguide.html\
There are some deviations though, mostly due to historical reasons as the original code did not use this coding style. There are some deviations though, mostly due to historical reasons as the original code did not use this coding style.
The most obvious and important points to consider: The most obvious and important points to consider:
@ -14,16 +14,15 @@ The most obvious and important points to consider:
* Comments always in C++ style, i.e. // instead of /* */ * Comments always in C++ style, i.e. // instead of /* */
* Comments should be proper sentences, starting with a capital letter and ending with a dot * Comments should be proper sentences, starting with a capital letter and ending with a dot
* K&R placements of braces, read the Linux Kernel coding style document for clarifications * K&R placements of braces, read the Linux Kernel coding style document for clarifications
* Always use spaces between keywords and opening brackets, i.e. 'if ()', 'for ()', 'while (' etc. * Always use spaces between keywords and opening brackets, i.e. `if ()`, `for ()`, `while (` etc.
* Avoid excessive inline functions as it bloats the binary and provides dubious performance gains * Avoid excessive inline functions as it bloats the binary and provides dubious performance gains
* In C++ functions are called functions (or member functions) and not methods like in Java :)
* For the rest, check the code! * For the rest, check the code!
Development Environment Development Environment
======================= =======================
EmulationStation-DE is developed and compiled using GCC and GDB. EmulationStation-DE is developed and compiled using GCC and GDB.\
For debugging purposes, starting the application like this could make sense: For debugging purposes, starting the application like this could make sense:
`emulationstation --windowed --debug --resolution 1280 720` `emulationstation --windowed --debug --resolution 1280 720`

20
LICENSE.md
View file

@ -1 +1,19 @@
Please find the individual license files inside the LICENSES directory. Copyright (c) 2014 Alec Lofquist
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

19
LICENSES/EmulationStation
View file

@ -1,19 +0,0 @@
Copyright (c) 2014 Alec Lofquist
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

1
NEWS.md
View file

@ -1,4 +1,5 @@
v1.0.0 v1.0.0
======
### General ### General

2
README.md
View file

@ -8,7 +8,7 @@ used with RetroArch, although it's certainly possible to configure the software
As it's intended for RetroArch and for usage on desktop computers, there has been no effort spent on trying to create advanced emulator or system configuration tools in the frontend, it's better to let the emulator itself handle that. Rather the goal is to keep the code as clean and fast as possible and to avoid bloat. As it's intended for RetroArch and for usage on desktop computers, there has been no effort spent on trying to create advanced emulator or system configuration tools in the frontend, it's better to let the emulator itself handle that. Rather the goal is to keep the code as clean and fast as possible and to avoid bloat.
Check the GIT repository and/or the NEWS.md file for information of improvements and bug fixes. Check the Git repository and/or the NEWS.md file for information of improvements and bug fixes.
This fork was initially based off RetroPie EmulationStation v2.10.0rp-dev (master). This fork was initially based off RetroPie EmulationStation v2.10.0rp-dev (master).