Merge pull request #49 from BrokenCommander/master

ReadMe cleanup
bite-your-idols · Feb 4, 2017 · 751c049 · 751c049
2 parents 2b5e64d + aca2f7e
commit 751c049
Show file tree

Hide file tree

Showing 3 changed files with 153 additions and 39 deletions.
diff --git a/README-DE.md b/README-DE.md
@@ -0,0 +1,77 @@
+# Gamestarter Pi
+![Gamestarter-logo](https://github.com/bite-your-idols/gamestarter/raw/master/assets/gamestarter-logo-dark.jpg)
+
+[English](https://github.com/bite-your-idols/gamestarter/blob/master/README.md) / [Spanish](https://github.com/bite-your-idols/gamestarter/blob/master/README-ES.md) / German
+
+## Retrogaming Kodi Addon für Raspberry Pi 2/3
+Benutzt du deinen **Raspberry Pi** als **Media Center**, in Verbindung mit **Kodi** in [LibreELEC](https://libreelec.tv/) oder [OpenELEC](http://openelec.tv/), und möchtest deine Retrogames spielen ohne ein Dual-Boot-System, mehrere SD Karten oder komplizierte Installationen? **Dann ist das die perfekte Lösung.**
+
+Mit diesem Addon wird es dir dank [Advanced Launcher](http://forum.kodi.tv/showthread.php?tid=85724) / [Advanced Emulator Launcher](http://forum.kodi.tv/showthread.php?tid=287826) möglich sein, **mehrere Emulatoren** von [RetroArch](http://libretro.com/) zu benutzen.  Siehe unten für eine Liste der unterstützten Systeme.
+
+## Installationsanleitung
+- Lade die [neuste Version](https://github.com/bite-your-idols/Gamestarter-Pi/releases/latest) herunter und kopiere sie auf deinen **Raspberry Pi**
+- Öffne **Kodi → Einstellungen → System → Addons** und aktiviere **Unbekannte Quellen**
+- Öffne **Kodi → Addons → Aus ZIP-Datei installieren** und wähle deine heruntergeladene `.zip`-Datei
+
+Wenn das Addon zum ersten Mal gestartet wird, erfolgt eine Erstkonfiguration. Danach kannst du deine [ROMs](https://github.com/libretro/Lakka/wiki/ROMs) und [BIOSes](https://github.com/libretro/Lakka/wiki/BIOSes) über [Samba](https://wiki.libreelec.tv/index.php?title=Accessing_LibreELEC#tab=Samba_2FSMB) nach `/storage/emulators/` kopieren.
+
+## Zusätzliche Programme
+Du kannst die Addon Einstellungen aufrufen um zusätzliche Funktionen zu installieren.
+- **[EmulationStation](http://emulationstation.org/):** ein schöne Benutzeroberfläche, auch benutzt von [RetroPie](https://retropie.org.uk/) und [Recalbox](https://recalbox.com/), und zusätzliche Designs
+- **[Internet Archive ROM Launcher](https://github.com/zach-morris/plugin.program.iarl/wiki):** ein Addon um Spiele vom [Internet Archive](https://archive.org/) zu starten (siehe [#31](https://github.com/bite-your-idols/Gamestarter-Pi/issues/31))
+- **Experimentelle RetroArch Emulatoren:** [lr-desmume](https://github.com/libretro/desmume), [lr-mame2010](https://github.com/libretro/mame2010-libretro), [lr-yabause](https://github.com/libretro/yabause)
+- **[uae4arm-rpi](https://github.com/Chips-fr/uae4arm-rpi):** Amiga Emulator (siehe [#34](https://github.com/bite-your-idols/Gamestarter-Pi/issues/34))
+- **[Libretro PC Portierungen](https://buildbot.libretro.com/assets/cores/):** Cave Story, Doom, Quake, Dinothawr
+
+Du kannst [diesen](https://github.com/bite-your-idols/Gamestarter-Pi/raw/master/packages/skin.estuary.zip) **modifizieren Estuary Skin** herunterladen, um einen **Games** Menüpunkt im Hauptmenü zu erhalten (siehe [#48](https://github.com/bite-your-idols/Gamestarter-Pi/issues/48)).
+
+## Unterstützte Systeme
+### Beliebte Systeme
+- *Arcade* ([lr-mame2003](https://github.com/libretro/mame2003-libretro) / [lr-fbalpha](https://github.com/libretro/fbalpha))
+- MSX / MSX2 ([lr-bluemsx](https://github.com/libretro/blueMSX-libretro) / [lr-fmsx](https://github.com/libretro/fmsx-libretro))
+- Neo Geo ([lr-fbalpha](https://github.com/libretro/fbalpha))
+- Nintendo 64 ([lr-glupen64](https://github.com/GLupeN64/GLupeN64) / [lr-mupen64plus](https://github.com/libretro/mupen64plus-libretro))
+- Nintendo Game Boy / Game Boy Color ([lr-gambatte](https://github.com/libretro/Gambatte-libretro))
+- Nintendo Game Boy Advanced ([lr-gpsp](https://github.com/libretro/gpsp) / [lr-mgba](https://github.com/libretro/mgba))
+- Nintendo NES ([lr-fceumm](https://github.com/libretro/libretro-fceumm) / [lr-nestopia](https://github.com/libretro/nestopia) / [lr-quicknes](https://github.com/libretro/QuickNES_Core))
+- Nintendo SNES ([lr-snes9x2002](https://github.com/libretro/snes9x2002) / [lr-snes9x2005](https://github.com/libretro/snes9x2005) / [lr-snes9x2010](https://github.com/libretro/snes9x2010))
+- Sega Master System ([lr-picodrive](https://github.com/libretro/picodrive) / [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX))
+- Sega Mega Drive / Mega-CD ([lr-picodrive](https://github.com/libretro/picodrive) / [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX))
+- Sony Playstation ([lr-pcsx-rearmed](https://github.com/libretro/pcsx_rearmed))
+- Sony PSP ([lr-ppsspp](https://github.com/libretro/libretro-ppsspp))
+- TurboGrafx-16 / PC Engine / PC Engine CD ([lr-mednafen-pce-fast](https://github.com/libretro/beetle-pce-fast-libretro) / [lr-mednafen-supergrafx](https://github.com/libretro/beetle-supergrafx-libretro))
+
+### Zusätzliche Systeme
+- *Arcade* ([lr-mame2000](https://github.com/libretro/mame2000-libretro))
+- Amiga ([lr-uae4arm](https://github.com/r-type/uae4arm-libretro) / [uae4arm-rpi](https://github.com/Chips-fr/uae4arm-rpi))
+- Atari 800 ([lr-atari800](https://github.com/r-type/libretro-atari800))
+- Atari 2600 ([lr-stella](https://github.com/libretro/stella-libretro))
+- Atari 7800 ([lr-prosystem](https://github.com/libretro/prosystem-libretro))
+- Atari Lynx ([lr-handy](https://github.com/libretro/libretro-handy))
+- DOSBox ([lr-dosbox](https://github.com/libretro/dosbox-libretro))
+- Game & Watch ([lr-gw](https://github.com/libretro/gw-libretro))
+- Magnavox Odyssey²/ Philips Videopac G7000 ([lr-o2em](https://github.com/libretro/libretro-o2em))
+- Neo Geo Pocket / Neo Geo Pocket Color ([lr-mednafen-ngp](https://github.com/libretro/beetle-ngp-libretro))
+- Sega Game Gear ([lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX))
+- ScummVM ([lr-scummvm](https://github.com/libretro/scummvm))
+- Vectrex ([lr-vecx](https://github.com/libretro/libretro-vecx))
+- WondeSwan / WonderSwan Color ([lr-mednafen-wswan](https://github.com/libretro/beetle-wswan-libretro))
+- ZX Spectrum ([lr-fuse](https://github.com/libretro/fuse-libretro))
+
+### Experimentelle Systeme
+- *Arcade* ([lr-mame2010](https://github.com/libretro/mame2010-libretro))
+- Amiga ([lr-fsuae](https://github.com/libretro/libretro-fsuae))
+- Nintendo DS ([lr-desmume](https://github.com/libretro/desmume))
+- Sega Saturn ([lr-yabause](https://github.com/libretro/yabause))
+
+## Mitwirkende
+- Erstellt von [bite-your-idols](https://github.com/bite-your-idols)
+- Ursprüngliches **RetroArch** Addon von [mezo](http://openelec.tv/forum/128-addons/72972-retroarch-addon-arm-rpi)
+- **UAE4ARM** & **EmulationStation** kompiliert von [escalade](https://forum.libreelec.tv/thread-302.html)
+- **Advanced Launcher** Emulator Icons von [tronkyfran](https://github.com/HerbFargus/es-theme-tronkyfran)
+- **ReadMe** von [BrokenCommander](https://github.com/BrokenCommander)
+
+---
+
+![screenshot-advlauncher-mimic](https://github.com/bite-your-idols/Gamestarter-Pi/raw/master/assets/screenshot-gamestarter-advlauncher-mimic.png)
+**Advanced Launcher** Bibliothek mit dem [Mimic Skin](http://kodi.wiki/view/Add-on:mimic)
diff --git a/README-ES.md b/README-ES.md
@@ -1,11 +1,11 @@
 # Gamestarter Pi
 ![gamestarter-logo](https://github.com/bite-your-idols/gamestarter/raw/master/assets/gamestarter-logo-dark.jpg)
 
-[English](https://github.com/bite-your-idols/gamestarter/)/Spanish
+[English](https://github.com/bite-your-idols/gamestarter/) / Spanish / [German](https://github.com/bite-your-idols/gamestarter/blob/master/README-DE.md)
 
 
 
-## Retrogamig addon para Kodi en Raspberry Pi
+## Retrogaming addon para Kodi en Raspberry Pi
 Si usas la Raspberry Pi 2/3 como media center corriendo Kodi en [LibreELEC](https://libreelec.tv/) o [OpenELEC](http://openelec.tv/), te gusta jugar a juegos retro y quieres lanzarlos como haces con tus pelis o series sin tener que estar cambiado de tarjeta, ni tener arranque dual ni nada de eso, aqui tienes la solución definitiva.
 
 Con este addon continuarás teniendo tu propia versión de Kodi pero vitaminada con el maravilloso multi-emulador [Retroarch](http://www.libretro.com/) integrado en kodi gracias al addon [AdvacedLauncher](http://forum.kodi.tv/showthread.php?tid=85724)/[Advanced Emulator Launcher](http://forum.kodi.tv/showthread.php?tid=287826). Mira la lista de emuladores [aquí](https://github.com/bite-your-idols/Gamestarter-Pi/issues/35).

diff --git a/README.md b/README.md
@@ -1,40 +1,77 @@
 # Gamestarter Pi
 ![Gamestarter-logo](https://github.com/bite-your-idols/gamestarter/raw/master/assets/gamestarter-logo-dark.jpg)
 
-English/[Spanish](https://github.com/bite-your-idols/gamestarter/blob/master/README-ES.md)
-
-
-## Retrogamig addon for Raspberry Pi's Kodi.
-
-If you use a Raspberry Pi 2/3 as a media center running Kodi on [LibreELEC](https://libreelec.tv/) or [OpenELEC](http://openelec.tv/), you like retrogaming and you want to launch games just as you do with movies and tv shows without dual-booting, swaping SD memories, complex installations... Here you have the ultimate solution.
-
-With this addon you will continue with your own customized Kodi but empowered with the awesome [RetroArch](http://www.libretro.com/) multi-emulator integrated in your Kodi library thanks to [AdvacedLauncher](http://forum.kodi.tv/showthread.php?tid=85724)/[Advanced Emulator Launcher](http://forum.kodi.tv/showthread.php?tid=287826) addon. Check out included systems [here](https://github.com/bite-your-idols/Gamestarter-Pi/issues/35).
-
-
-## Installation Instructions.
-
-Download the latest release of the addon from [Releases Page](https://github.com/bite-your-idols/Gamestarter-Pi/releases/latest), copy into your Raspberry Pi 2/3 and select "install from zip" in Settings>Addons menu. The first time the addon is launched it will perform set-up . Then copy your [roms and bios](https://github.com/libretro/Lakka/wiki/ROMs-and-BIOSes) to /storage/emulators/ folder via ftp or [samba](http://wiki.openelec.tv/index.php/Accessing_Samba_Shares) and reboot.
-
-
-## Optional Installations.
-
-After firts-time-setup you can open addon settings to install additional features such as:
-- [EmulationStation](https://github.com/Herdinger/EmulationStation) (the same frontend RetroPie and Recalbox use) and themes (ES does not work in OE6-)
-- [Internet Archive ROM Launcher](https://github.com/zach-morris/plugin.program.iarl/wiki) addon to launch games from the "cloud" ([config instructions](https://github.com/bite-your-idols/Gamestarter-Pi/issues/31))
-- RetroArch experimental cores (Mame2010, yabause, reicast, desmume...)
-- UAE4ARM Amiga emulator ([info about amiga emulation](https://github.com/bite-your-idols/Gamestarter-Pi/issues/34))
-- Libretro PC ports (Cave Story, Quake, Doom & Dinothawr)
-- 3 GameMaker Pi ports including modern masterpiece "Maldita Castilla" ([More Info](https://github.com/bite-your-idols/gamemaker-pi))
-
-## Credits.
-
-- Original RetroArch addon by [Mezo](http://openelec.tv/forum/128-addons/72972-retroarch-addon-arm-rpi)
-- UAE4ARM & EmulationStation compiled by [Escalade](https://forum.libreelec.tv/thread-302.html)
-- AdvancedLauncher "skin" images by [tronkyfran](https://github.com/HerbFargus/es-theme-tronkyfran)
-
-.
-
-![screenshot-advlauncher-edit](https://github.com/bite-your-idols/Gamestarter-Pi/raw/master/assets/screenshot-gamestarter-advlauncher-mimic.png)
-Example of Kodi's game "library" with [Mimic Skin](http://kodi.wiki/view/Add-on:mimic).
-
-
+English / [Spanish](https://github.com/bite-your-idols/gamestarter/blob/master/README-ES.md) / [German](https://github.com/bite-your-idols/gamestarter/blob/master/README-DE.md)
+
+## Retrogaming Kodi addon for Raspberry Pi 2/3
+Do you use your **Raspberry Pi** as a **media center**, running **Kodi** in [LibreELEC](https://libreelec.tv/) or [OpenELEC](http://openelec.tv/), and you want to play your retro games without dual-booting, swaping SD cards or complex installation? **Then this is the perfect solution.**
+
+With this addon you will be able to run **multiple emulators** from [RetroArch](http://libretro.com/) thanks to [Advanced Launcher](http://forum.kodi.tv/showthread.php?tid=85724) / [Advanced Emulator Launcher](http://forum.kodi.tv/showthread.php?tid=287826). Check out the included systems below.
+
+## Installation instructions
+- Download the [latest release](https://github.com/bite-your-idols/Gamestarter-Pi/releases/latest) and transfer it to your **Raspberry Pi**
+- Go to **Kodi → Settings → System → Add-ons** and enable **Unknown sources**
+- Go to **Kodi → Add-ons → Install from zip file** and select the downloaded `.zip` file
+
+The first time the addon is launched, it will perform a initial setup. You can then copy your [ROMs](https://github.com/libretro/Lakka/wiki/ROMs) and [BIOSes](https://github.com/libretro/Lakka/wiki/BIOSes) to `/storage/emulators/` via [Samba](https://wiki.libreelec.tv/index.php?title=Accessing_LibreELEC#tab=Samba_2FSMB).
+
+## Optional packages
+You can open the addon settings to install additional features.
+- **[EmulationStation](http://emulationstation.org/):** a nice frontend also used by [RetroPie](https://retropie.org.uk/) and [Recalbox](https://recalbox.com/) and additional themes
+- **[Internet Archive ROM Launcher](https://github.com/zach-morris/plugin.program.iarl/wiki):** addon to launch games from the [Internet Archive](https://archive.org/) (see [#31](https://github.com/bite-your-idols/Gamestarter-Pi/issues/31))
+- **Experimental RetroArch cores:** [lr-desmume](https://github.com/libretro/desmume), [lr-mame2010](https://github.com/libretro/mame2010-libretro), [lr-yabause](https://github.com/libretro/yabause)
+- **[uae4arm-rpi](https://github.com/Chips-fr/uae4arm-rpi):** Amiga emulator (see [#34](https://github.com/bite-your-idols/Gamestarter-Pi/issues/34))
+- **[Libretro PC ports](https://buildbot.libretro.com/assets/cores/):** Cave Story, Doom, Quake, Dinothawr
+
+You can download [this](https://github.com/bite-your-idols/Gamestarter-Pi/raw/master/packages/skin.estuary.zip) **modified Estuary Skin** to get a **Games** section in the home menu (see [#48](https://github.com/bite-your-idols/Gamestarter-Pi/issues/48)).
+
+## Included systems
+### Popular systems
+- *Arcade* ([lr-mame2003](https://github.com/libretro/mame2003-libretro) / [lr-fbalpha](https://github.com/libretro/fbalpha))
+- MSX / MSX2 ([lr-bluemsx](https://github.com/libretro/blueMSX-libretro) / [lr-fmsx](https://github.com/libretro/fmsx-libretro))
+- Neo Geo ([lr-fbalpha](https://github.com/libretro/fbalpha))
+- Nintendo 64 ([lr-glupen64](https://github.com/GLupeN64/GLupeN64) / [lr-mupen64plus](https://github.com/libretro/mupen64plus-libretro))
+- Nintendo Game Boy / Game Boy Color ([lr-gambatte](https://github.com/libretro/Gambatte-libretro))
+- Nintendo Game Boy Advanced ([lr-gpsp](https://github.com/libretro/gpsp) / [lr-mgba](https://github.com/libretro/mgba))
+- Nintendo NES ([lr-fceumm](https://github.com/libretro/libretro-fceumm) / [lr-nestopia](https://github.com/libretro/nestopia) / [lr-quicknes](https://github.com/libretro/QuickNES_Core))
+- Nintendo SNES ([lr-snes9x2002](https://github.com/libretro/snes9x2002) / [lr-snes9x2005](https://github.com/libretro/snes9x2005) / [lr-snes9x2010](https://github.com/libretro/snes9x2010))
+- Sega Master System ([lr-picodrive](https://github.com/libretro/picodrive) / [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX))
+- Sega Mega Drive / Mega-CD ([lr-picodrive](https://github.com/libretro/picodrive) / [lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX))
+- Sony Playstation ([lr-pcsx-rearmed](https://github.com/libretro/pcsx_rearmed))
+- Sony PSP ([lr-ppsspp](https://github.com/libretro/libretro-ppsspp))
+- TurboGrafx-16 / PC Engine / PC Engine CD ([lr-mednafen-pce-fast](https://github.com/libretro/beetle-pce-fast-libretro) / [lr-mednafen-supergrafx](https://github.com/libretro/beetle-supergrafx-libretro))
+
+### Additional systems
+- *Arcade* ([lr-mame2000](https://github.com/libretro/mame2000-libretro))
+- Amiga ([lr-uae4arm](https://github.com/r-type/uae4arm-libretro) / [uae4arm-rpi](https://github.com/Chips-fr/uae4arm-rpi))
+- Atari 800 ([lr-atari800](https://github.com/r-type/libretro-atari800))
+- Atari 2600 ([lr-stella](https://github.com/libretro/stella-libretro))
+- Atari 7800 ([lr-prosystem](https://github.com/libretro/prosystem-libretro))
+- Atari Lynx ([lr-handy](https://github.com/libretro/libretro-handy))
+- DOSBox ([lr-dosbox](https://github.com/libretro/dosbox-libretro))
+- Game & Watch ([lr-gw](https://github.com/libretro/gw-libretro))
+- Magnavox Odyssey² / Philips Videopac G7000 ([lr-o2em](https://github.com/libretro/libretro-o2em))
+- Neo Geo Pocket / Neo Geo Pocket Color ([lr-mednafen-ngp](https://github.com/libretro/beetle-ngp-libretro))
+- Sega Game Gear ([lr-genesis-plus-gx](https://github.com/libretro/Genesis-Plus-GX))
+- ScummVM ([lr-scummvm](https://github.com/libretro/scummvm))
+- Vectrex ([lr-vecx](https://github.com/libretro/libretro-vecx))
+- WondeSwan / WonderSwan Color ([lr-mednafen-wswan](https://github.com/libretro/beetle-wswan-libretro))
+- ZX Spectrum ([lr-fuse](https://github.com/libretro/fuse-libretro))
+
+### Experimental systems (WIP)
+- *Arcade* ([lr-mame2010](https://github.com/libretro/mame2010-libretro))
+- Amiga ([lr-fsuae](https://github.com/libretro/libretro-fsuae))
+- Nintendo DS ([lr-desmume](https://github.com/libretro/desmume))
+- Sega Saturn ([lr-yabause](https://github.com/libretro/yabause))
+
+## Credits
+- Created by [bite-your-idols](https://github.com/bite-your-idols)
+- Original **RetroArch** addon by [mezo](http://openelec.tv/forum/128-addons/72972-retroarch-addon-arm-rpi)
+- **UAE4ARM** & **EmulationStation** compiled by [escalade](https://forum.libreelec.tv/thread-302.html)
+- **Advanced Launcher** emulator icons by [tronkyfran](https://github.com/HerbFargus/es-theme-tronkyfran)
+- **ReadMe** by [BrokenCommander](https://github.com/BrokenCommander)
+
+---
+
+![screenshot-advlauncher-mimic](https://github.com/bite-your-idols/Gamestarter-Pi/raw/master/assets/screenshot-gamestarter-advlauncher-mimic.png)
+**Advanced Launcher** library with the [Mimic Skin](http://kodi.wiki/view/Add-on:mimic)