mirror/RetroArch
1
0
Fork 0
mirror of https://github.com/libretro/RetroArch synced 2025-02-27 09:41:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme to reflect the new changes

Browse Source
This commit is contained in:
Themaister 2011-01-01 16:03:15 +01:00
parent aa4a6a4a04
commit 840cfee660
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -10,9 +10,7 @@ This enables the possibility of custom front-ends for the emulator.
# Philosophy # Philosophy
SSNES attempts to be very small and lean, while still having all the useful core features expected from an emulator. SSNES attempts to be very small and lean, while still having all the useful core features expected from an emulator.
It is close in spirit to suckless' DWM, in that configuring the emulator requires a recompile. It is used through command-line.
The configuration is done through editing a C header file.
C programming skills are not necessary to configure it (no programming involved), but some basic programming experience might be needed.
# Dependencies # Dependencies
@ -33,6 +31,7 @@ SSNES needs one of these audio driver libraries:
- RoarAudio - RoarAudio
- RSound - RSound
- OpenAL - OpenAL
- JACK
# Building libsnes # Building libsnes
@ -46,17 +45,26 @@ SSNES needs one of these audio driver libraries:
# Configuring # Configuring
SSNES configuring is done through editing <tt>config.h</tt> and <tt>config.mk</tt>. The default configuration is defined in config.def.h.
The default configs can be found in <tt>config.h.def</tt> and <tt>config.mk.def</tt> respectively. These can later be tweaked by using the ssnes config file.
Do note that you might have to edit <tt>config.mk</tt> if you edit driver and filter options! A sample configuration file is installed to /etc/ssnes.cfg.
By default, ALSA audio driver is assumed. This is the system-wide config file.
Each user should create a config file in $XDG\_CONFIG\_HOME/ssnes.
The users only need to configure a certain option if the desired value deviates from the value defined in config.def.h.
Most options in <tt>config.h</tt> should be self-explanatory.
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.
# Compiling and installing # Compiling and installing
The good old <tt>make && sudo make install</tt> should do the trick :) 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.
Notable options for ./configure:
--with-libsnes=: Normally libsnes is located with -lsnes, however, this can be overridden.
--enable-dynamic: Do not link to libsnes at compile time, but load libsnes dynamically at runtime. libsnes\_path in config file defines which library to load. Useful for development.
Do note that these two options are mutually exclusive.
# Filters and Cg shader support # Filters and Cg shader support
@ -67,3 +75,5 @@ Cg shaders are compiled at run-time, and shaders could be dropped in.
All shaders share a common interface to pass some essential arguments such as texture size and viewport size. (Common for pixel art scalers) All shaders share a common interface to pass some essential arguments such as texture size and viewport size. (Common for pixel art scalers)
Some Cg shaders are included in hqflt/cg/ and could be used as an example. Some Cg shaders are included in hqflt/cg/ and could be used as an example.
While these shaders are Cg, they closely resemble the GLSL shaders found in bSNES shader pack, so porting them is trivial.