From 840cfee6604f6c5583bb89dfe79f400fd24dde55 Mon Sep 17 00:00:00 2001 From: Themaister Date: Sat, 1 Jan 2011 16:03:15 +0100 Subject: [PATCH] Update readme to reflect the new changes --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ab32262042..446165946e 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,7 @@ This enables the possibility of custom front-ends for the emulator. # Philosophy 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. -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. +It is used through command-line. # Dependencies @@ -33,6 +31,7 @@ SSNES needs one of these audio driver libraries: - RoarAudio - RSound - OpenAL + - JACK # Building libsnes @@ -46,17 +45,26 @@ SSNES needs one of these audio driver libraries: # Configuring -SSNES configuring is done through editing config.h and config.mk. -The default configs can be found in config.h.def and config.mk.def respectively. -Do note that you might have to edit config.mk if you edit driver and filter options! -By default, ALSA audio driver is assumed. +The default configuration is defined in config.def.h. +These can later be tweaked by using the ssnes config file. +A sample configuration file is installed to /etc/ssnes.cfg. +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 config.h should be self-explanatory. To configure joypads, start up jstest /dev/input/js0 to determine which joypad buttons (and axis) to use. # Compiling and installing -The good old make && sudo make install should do the trick :) +As most packages, SSNES is built using the standard ./configure && make && make install +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 @@ -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) 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. +