From 7920753718f13e61c59d11531a0738d913990ed5 Mon Sep 17 00:00:00 2001 From: Aloshi Date: Thu, 2 Aug 2012 13:27:37 -0500 Subject: [PATCH] Updated the README. --- README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 473b1d4b7..4bd9edf7c 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,12 @@ I'm not associated with RetroArch in any way! Building ======== -EmulationStation has a few dependencies. For building, you'll need SDL 1.2, the SDL TTF library, and Boost.Filesystem, which can easily be obtained with apt-get: -`sudo apt-get install libsdl1.2-dev` -`sudo apt-get install libsdl-ttf2.0-dev` -`sudo apt-get install libboost-filesystem-dev` +EmulationStation has a few dependencies. For building, you'll need SDL 1.2, the SDL TTF library, the SDL image library, and Boost.Filesystem, which can easily be obtained with apt-get: +```sudo apt-get install libsdl1.2-dev +sudo apt-get install libsdl-ttf2.0-dev +sudo apt-get install libboost-filesystem-dev +sudo apt-get install libsdl-image1.2-dev +``` You can build EmulationStation by simply running `make`. @@ -29,5 +31,25 @@ Keep in mind you'll have to set up your emulator separately from EmulationStatio EmulationStation will return once your system's command terminates (i.e. your emulator closes). To close EmulationStation itself, you can press the F4 key on the keyboard. + +gamelist.xml +============ + +If a file named gamelist.xml is found, it will be parsed and the detailed GuiGameList will be used. This means you can define screenshots, descriptions, and alternate names for files. +Screenshots are meant to be 256x256, but ES won't stop you from using other sizes - they'll just be placed wrong. +An example gamelist.xml: +``` + + /home/pi/ROMs/nes/mm2.nes + Mega Man 2 + Mega Man 2 is a classic NES game which follows Mega Man as he murders eight robot masters. + /home/pi/Screenshots/megaman2.png + + +``` + +The path element should be the absolute path of the ROM. Special characters SHOULD NOT be escaped. The image element is the absolute path to an image to use (like a screenshot or boxart). Most formats can be used (including png, jpg, gif, etc.). Look up the SDL_image library for a full list. Not all elements need to be used. + + -Aloshi http://www.aloshi.com