Adds initial Funkey S support

1 files changed, 58 insertions, 0 deletions

diff --git a/README.funkey-s.md b/README.funkey-s.md
new file mode 100644
index 0000000..0513f5a
--- /dev/null
+++ b/README.funkey-s.md
@@ -0,0 +1,58 @@
+# picoarch - a libretro frontend designed for small screens and low power
+
+picoarch runs libretro cores (emulators) for various systems with low overhead and UI designed for small screen, low-powered devices like the Trimui Model S (PowKiddy A66) and Funkey S.
+
+It supports: 
+
+- **Arcade** (mame2000)
+- **Colecovision** (blueMSX, smsplus)
+- **Game Boy / Game Boy Color** (gambatte)
+- **Game Boy Advance** (gpsp)
+- **Game Gear** (picodrive, smsplus)
+- **Genesis** (picodrive)
+- **MSX** (fMSX, blueMSX)
+- **NES** (quicknes, fceumm)
+- **Sega Master System** (picodrive, smsplus)
+- **Super NES** (snes9x2002, snes9x2005, snes9x2005_plus)
+- **PCE / TurboGrafx-16** (beetle-pce-fast)
+- **PlayStation** (pcsx_rearmed)
+- more to come
+
+picoarch can also play game music (gme).
+
+All emulators have:
+
+- FunKey menu
+- fast-forward
+- soft scaling options
+- per-game config
+- screenshots
+
+Most have:
+- FunKey Instant Play (close / reopen device, requires core with save states)
+- autosave and resume (requires core with save states)
+- cheat support
+- IPS/BPS softpatching
+- auto-frameskip for smooth audio
+
+## Install
+
+Mount USB and copy picoarch.opk into Emulators directory.
+
+## Notes / extra features
+
+### BIOS
+
+Some emulators require bios files. bios files are placed into `/mnt/FunKey/.picoarch/system`. This directory is created after first launch.
+
+The libretro documentation specifies which bios is required for each core. For example, needed fMSX bios files are listed here: <https://docs.libretro.com/library/fmsx/>
+
+### Cheats
+
+Cheats use RetroArch .cht file format. Many cheat files are here <https://github.com/libretro/libretro-database/tree/master/cht>
+
+Cheat file name needs to match ROM name, and go underneath save directory. For example, `/Apps/.picoarch-gambatte/cheats/Super Mario Land (World).cht`. When a cheat file is detected, a "cheats" menu item will appear in advanced menu. Not all cheats work with all cores, may want to clean up files to just the cheats you want.
+
+### IPS / BPS soft-patching
+
+Many cores can apply patches when loading. For example, loading `/roms/game.gba` will apply patches named `/roms/game.ips`, `/roms/game.ips1`, `/roms/game.IPS2`, `/roms/game.bps`, etc. Patching is temporary, original files are unmodified. Patches are loaded in case-insensitive alphabetical order. Note that `.ips12` loads before `.ips2`, but after `.ips02`.