Update README.

This commit is contained in:
Themaister 2011-01-25 13:24:51 +01:00
parent b8aa08de8b
commit fb66fecb8a

View File

@ -4,7 +4,7 @@ SSNES is a simple frontend for the libsnes library.
# libsnes
libsnes is the emulator core of [bSNES](http://www.byuu.org), the most accurate SNES emulator to date, in library form.
libsnes is the emulator core of [bSNES](http://www.byuu.org), the most accurate SNES emulator to date, in library form. The libsnes API has been implemented by SNES9x as well, allowing multiple different cores to be used for an emulator that supports libsnes.
This enables the possibility of custom front-ends for the emulator.
# Philosophy
@ -24,6 +24,7 @@ SSNES can utilize these libraries if enabled:
- nvidia-cg-toolkit
- libxml2 (bSNES XML shaders)
- libfreetype2 (TTF font rendering on screen)
SSNES needs one of these audio driver libraries:
@ -33,6 +34,7 @@ SSNES needs one of these audio driver libraries:
- RSound
- OpenAL
- JACK
- SDL
# Building libsnes
@ -53,10 +55,11 @@ This is the system-wide config file.
Each user should create a config file in $XDG\_CONFIG\_HOME/ssnes/ssnes.cfg.
The users only need to configure a certain option if the desired value deviates from the value defined in config.def.h.
To configure joypads, start up <tt>jstest /dev/input/js0</tt> to determine which joypad buttons (and axis) to use.
To configure joypads, start up <tt>jstest /dev/input/js0</tt> to determine which joypad buttons (and axis) to use. It is also possible to use the <tt>ssnes-joyconfig</tt> tool as well for simple configuration.
# Compiling and installing
<b>Linux/Unix</b>
As most packages, SSNES is built using the standard <tt>./configure && make && make install</tt>
Do note that the build system is not autotools based, but resembles it.
@ -66,6 +69,17 @@ Notable options for ./configure:
Do note that these two options are mutually exclusive.
<b>Win32</b>
It is possible with MinGW to compile for Windows in either msys or Linux/Unix based systems. Do note that Windows build uses a static Makefile since configuration scripts create more harm than good on this platform. Libraries, headers, etc, needed to compile and run SSNES can be fetched with a Makefile target.
In Linux/Unix:
<tt>make -f Makefile.win32 libs</tt>
<tt>make -f Makefile.win32 CC=i486-mingw32-gcc CXX=i486-mingw32-g++</tt>
In MSYS:
<tt>mingw32-make -f Makefile.win32 libs</tt>. You will need to have wget in your patch for this command! MSYS should provide this.
<tt>mingw32-make -f Makefile.win32</tt>
# Filters, bSNES XML shaders and Cg shader support