wiz r1 relese
[ginge.git] / readme.txt
CommitLineData
db9191ed 1\r
2GINGE - Ginge Is Not GP2X Emulator\r
3release 1\r
4\r
5(C) notaz, 2010\r
6http://notaz.gp2x.de/\r
7\r
8\r
9About\r
10-----\r
11\r
12Ginge is an application that can run many GP2X F100/F200 games on other ARM\r
13Linux platforms, which currently includes Wiz. It is not a full hardware\r
14emulator like MAME, PicoDrive or similar, it does not emulate the CPU. It can\r
15be considered as compatibility layer similar to Wine on PC Linux, however it\r
16does emulate small portion of MMSP2 system-on-chip. It operates by hooking\r
17certain system calls and using realtime patching of code that accesses memory\r
18mapped hardware directly.\r
19\r
20\r
21Usage\r
22-----\r
23\r
24Ginge comes with a launcher that is started when you run Ginge. The launcher\r
25can then be used to start GP2X software, which will either run if it's\r
26compatible, or just return back to the menu if it is not. In some cases it\r
27might hang though.\r
28\r
29\r
30Structure\r
31---------\r
32\r
33Ginge actually consists of 4 independent executables and a few scripts:\r
34\r
35+ ginge_sloader - loader of static executables\r
36+ ginge_dyn - dynamic executable handler\r
37+ ginge_prep - .gpe parser that selects the right handler from above\r
38+ gp2xmenu - the launcher/menu program\r
39+ ginge_dyn.sh - environment setup script for ginge_dyn\r
40+ ginge.sh/gpe - menu launcher script\r
41\r
42The menu is optional and can be replaced or bypassed completely. The only thing\r
43it does is running ginge_prep on GP2X .gpe program, ginge_prep handles the rest.\r
44\r
45\r
46License\r
47-------\r
48\r
49gp2xmenu is based on GPH GPL source (http://www.gnu.org/licenses/gpl.html).\r
50Source is available at http://notaz.gp2x.de/releases/ginge/gp2xmenu.tar.bz2\r
51\r
52Ginge may come with some libraries. Those libraries are unmodified copies\r
53of ones found in root filesystems in GP2X and Wiz and are included to more\r
54accurately reproduce environment on GP2X. Their source code may or may not be\r
55available, I do not have it nor did I use it.\r
56\r
57Remaining portion is released under custom closed source license. It is not\r
58derived from gp2xmenu and is completely standalone, the menu is only included\r
59for user's convenience.\r
60\r
61Redistribution and use of program's binaries and helper scripts, with or without\r
62modification, is permitted provided that the following conditions are met:\r
63 * This readme is included in unmodified form.\r
64 * The program in any of it's forms is not sold or used as part of any\r
65 commercial package, including pre-installed or included in any kind of\r
66 portable device.\r
67 * It is not bundled or distributed with any GP2X program without respective\r
68 program's author's permission.\r
69\r
70THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND\r
71ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
72WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
73DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER BE LIABLE FOR ANY\r
74DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
75(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
76LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
77ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
78(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
79SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
80\r