refactor dependencies

[ginge.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index 18f3ee0..3eb1913 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -1,6 +1,6 @@
 \r
 GINGE - Ginge Is Not GP2X Emulator\r
-release 1\r
+release 3\r
 \r
 (C) notaz, 2010\r
 http://notaz.gp2x.de/\r
@@ -9,13 +9,14 @@ http://notaz.gp2x.de/
 About\r
 -----\r
 \r
-Ginge is an application that can run many GP2X F100/F200 games on other ARM\r
-Linux platforms, which currently includes Wiz. It is not a full hardware\r
-emulator like MAME, PicoDrive or similar, it does not emulate the CPU. It can\r
-be considered as compatibility layer similar to Wine on PC Linux, however it\r
-does emulate small portion of MMSP2 system-on-chip. It operates by hooking\r
-certain system calls and using realtime patching of code that accesses memory\r
-mapped hardware directly.\r
+Ginge is an application that can run many GP2X F100/F200, Wiz games and\r
+programs on other ARM Linux platforms, which currently includes Pandora\r
+and Wiz itself. It is not a full hardware emulator like MAME, PicoDrive or\r
+similar, it does not emulate the CPU. It can be considered as compatibility\r
+layer similar to Wine on PC Linux, however it does emulate small portion of\r
+MMSP2 and Pollux system-on-chips. It operates by hooking certain system calls\r
+and using realtime patching of code that accesses memory mapped hardware\r
+directly.\r
 \r
 \r
 Usage\r
@@ -26,6 +27,14 @@ can then be used to start GP2X software, which will either run if it's
 compatible, or just return back to the menu if it is not. In some cases it\r
 might hang though.\r
 \r
+Keys are mapped to corresponding keys on both pandora and Wiz, except:\r
+\r
+Key              Pandora   Wiz\r
+Stick Push       1         unmapped\r
+Volume up/down   '.', ','  Volume up/down\r
+\r
+On pandora pressing 'q' will exit the menu or try to kill current application.\r
+\r
 \r
 Structure\r
 ---------\r
@@ -43,6 +52,23 @@ The menu is optional and can be replaced or bypassed completely. The only thing
 it does is running ginge_prep on GP2X .gpe program, ginge_prep handles the rest.\r
 \r
 \r
+Changelog\r
+---------\r
+\r
+r3\r
+* improved exec handling, mostly for gpecomp.\r
++ added preliminary Wiz support, pcsx4all works.\r
+* Wiz: since some stuff is written to /tmp, mount tmpfs there when starting\r
+  to avoid wearing down flash.\r
+\r
+r2\r
+* improved exit handling\r
+* Wiz: should now return to Wiz menu after gp2xmenu exit\r
+\r
+r1 - initial release\r
++ icons provided by Inder\r
+\r
+\r
 License\r
 -------\r
 \r
@@ -51,8 +77,9 @@ Source is available at http://notaz.gp2x.de/releases/ginge/gp2xmenu.tar.bz2
 \r
 Ginge may come with some libraries. Those libraries are unmodified copies\r
 of ones found in root filesystems in GP2X and Wiz and are included to more\r
-accurately reproduce environment on GP2X. Their source code may or may not be\r
-available, I do not have it nor did I use it.\r
+accurately reproduce environment found on GP2X. Their source code may or may\r
+not be available, I did not I use it, but whatever I found is mirrored here:\r
+http://notaz.gp2x.de/downloads/gp2x/src/410_all/\r
 \r
 Remaining portion is released under custom closed source license. It is not\r
 derived from gp2xmenu and is completely standalone, the menu is only included\r
@@ -64,7 +91,7 @@ modification, is permitted provided that the following conditions are met:
   * The program in any of it's forms is not sold or used as part of any\r
     commercial package, including pre-installed or included in any kind of\r
     portable device.\r
-  * It is not bundled or distributed with any GP2X program without respective\r
+  * It is not bundled and distributed with any GP2X program without respective\r
     program's author's permission.\r
 \r
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND\r