add forgotten dist changes
[ginge.git] / readme.txt
index 8f2671e..3c35ee5 100644 (file)
-
-GINGE - Ginge Is Not GP2X Emulator
-
-(C) notaz, 2010
-http://notaz.gp2x.de/
-
-
-About
------
-
-Ginge is an application that can run many GP2X F100/F200 games on other ARM
-Linux platforms, which currently includes Wiz. It is not a full hardware
-emulator like MAME, PicoDrive or similar, it does not emulate the CPU. It can
-be considered as compatibility layer similar to Wine on PC Linux, however it
-does emulate small portion of MMSP2 system-on-chip. It operates by hooking
-certain system calls and using realtime patching of code that accesses memory
-mapped hardware directly.
-
-
-Usage
------
-
-Ginge comes with a launcher that is started when you run Ginge. The launcher
-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
-might hang though.
-
-
-Structure
----------
-
-Ginge actually consists of 4 independent executables and a few scripts:
-
-+ ginge_sloader - loader of static executables
-+ ginge_dyn     - dynamic executable handler
-+ ginge_prep    - .gpe parser that selects the right handler from above
-+ gp2xmenu      - the launcher/menu program
-+ ginge_dyn.sh  - environment setup script for ginge_dyn
-+ ginge.sh/gpe  - menu launcher script
-
-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.
-
-
-License
--------
-
-gp2xmenu is based on GPH GPL source (http://www.gnu.org/licenses/gpl.html).
-Source is available at 
-
-Remaining portion is released under custom closed source license. It is not
-derived from gp2xmenu and is completely standalone, the menu is only included
-for user's convenience.
-
-Redistribution and use of program's binaries and helper scripts, with or without
-modification, is permitted provided that the following conditions are met:
-  * This readme is included in unmodified form.
-  * The program in any of it's forms is not sold or used as part of any
-    commercial package, including pre-installed or included in any kind of
-    portable device.
-  * It is not bundled or distributed with any GP2X program without respective
-    program's author's permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
+\r
+GINGE - Ginge Is Not GP2X Emulator\r
+release 4\r
+\r
+(C) notaz, 2010-2011\r
+http://notaz.gp2x.de/\r
+\r
+\r
+About\r
+-----\r
+\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
+Caanoo and Wiz itself. It is not a full hardware emulator like MAME, PicoDrive\r
+or 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
+-----\r
+\r
+Ginge comes with a launcher that is started when you run Ginge. The launcher\r
+can then be used to start GP2X software, which will either run if it's\r
+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 pandora, Wiz and Caanoo , except:\r
+\r
+Key              Pandora   Wiz              Caanoo\r
+Stick Push       1         unmapped         Stick Push\r
+Volume up/down   '.', ','  Volume up/down   Home+I/Home+II\r
+\r
+On pandora pressing 'q' will exit the menu or try to kill current application.\r
+On Cannoo Home+Y tries to kill current application.\r
+\r
+\r
+Structure\r
+---------\r
+\r
+Ginge actually consists of 4 independent executables and a few scripts:\r
+\r
++ ginge_sloader - loader of static executables\r
++ ginge_dyn     - dynamic executable handler\r
++ ginge_prep    - .gpe parser that selects the right handler from above\r
++ gp2xmenu      - the launcher/menu program\r
++ ginge_dyn.sh  - environment setup script for ginge_dyn\r
++ ginge.sh/gpe  - menu launcher script\r
+\r
+The menu is optional and can be replaced or bypassed completely. The only thing\r
+it does is running ginge_prep on GP2X .gpe program, ginge_prep handles the rest.\r
+\r
+\r
+Changelog\r
+---------\r
+\r
+r4\r
++ ginge now runs on Caanoo\r
+* minor fixes in path handling\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
+gp2xmenu is based on GPH GPL source (http://www.gnu.org/licenses/gpl.html).\r
+Source is available at http://notaz.gp2x.de/releases/ginge/gp2xmenu.tar.bz2\r
+\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 found on GP2X. Their source code may or may\r
+not be available, I did not 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
+for user's convenience.\r
+\r
+Redistribution and use of program's binaries and helper scripts, with or without\r
+modification, is permitted provided that the following conditions are met:\r
+  * This readme is included in unmodified form.\r
+  * 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 and distributed with any GP2X or Wiz program without\r
+    respective program's author's permission.\r
+\r
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND\r
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
+DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER BE LIABLE FOR ANY\r
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
+\r