Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/retroarch-clover.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexey 'Cluster' Avdyukhin <ClusterM@users.noreply.github.com>2017-02-18 06:53:13 +0300
committerGitHub <noreply@github.com>2017-02-18 06:53:13 +0300
commitbb2a394701f3a67b780e561be653f30913e6c1a1 (patch)
tree4a47a0908d5f5b0d75ad415618b6bb4340f2d379 /README.md
parent83497f3ddb681733956ab8038170121c572ba903 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 47 insertions, 1 deletions
diff --git a/README.md b/README.md
index c7970b2..c58b7ff 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,47 @@
-# retroarch-clover \ No newline at end of file
+### RetroArch mod for hakchi ###
+
+This is hakchi/hakchi2 module which adds the RetroArch emulator to your NES Mini.
+
+It will automatically detect unsupported NES games and run them instead of the default emulator. Save states will work as usual.
+
+It can also run games for other consoles. This pack already contains the following cores:
+- emux_sms
+- fceumm
+- gambatte_libretro
+- genesis_plus_gx
+- nestopia
+- snes9x2010
+
+Available executables and arguments:
+
+ - retroarch-clover <core> <rom> <clover_args>
+ runs retroarch with specified core,
+ designed for executing from clover shell,
+ so it parses all clover arguments (saves, aspect ratio, etc.)
+ - /bin/gb <rom> <clover_args>
+ runs "gambatte" core
+ - /bin/md <rom> <clover_args>
+ runs "genesis_plus_gx" core
+ - /bin/nes <rom> <clover_args>
+ runs "fceumm" core
+ - /bin/sms <rom> <clover_args>
+ runs "emux_sms" core
+ - /bin/snes <rom> <clover_args>
+ runs "snes9x2010" core
+ - /bin/n64 <rom> <clover_args>
+ runs "mupen64plus" core
+ - /bin/retroarch-mini [core] [rom] [args]
+ runs RetroArch directly, without clover intergration
+ - /bin/retroarch
+ RetroArch itself
+
+Sometimes default emulator of NES mini is not working with some games when it should. So you can just add "--retroarch" command line argument to use RetroArch.
+
+
+NES Mini port by madmonkey
+
+NES Mini shell integration by Cluster
+
+RetroArch/libretro project: https://www.libretro.com
+
+(c) 2017