initial import

[picodrive.git] / _docs / readme.txt

\r
\r
Compiling Symbian ports\r
-----------------------\r
First note: there is no WINS support, because I use assembly code in some\r
places and I don't think emulator is useful for this project because of it's\r
too different behaviour compared to real device. If you need wins support,\r
you will have to add it yourself. In that case, you will have to use a68k\r
instead of Cyclone and mz80 instead of DrZ80. Emulator does have support\r
for these, also there is equivalent c code for the asm stuff, but you will\r
have to dig the sources and figure everything out yourself.\r
\r
Exe:\r
Before building the exe you will need to compile Cyclone, use the included\r
vc6 project or see Cyclone.txt for more info.\r
\r
I don't use standard Symbian build methods for exe, because I use ARM\r
assembly files (*.s) and different compiler options for different files,\r
and this is difficult to achieve with .mmp files. Also I use Cylone\r
patcher, check \cyclone\epoc\ for more info. So I use custom makefile\r
instead, but to use it, UIQROOT2 environmental variable must be set to\r
the root of your UIQ SDK. So to build, you need to type something like\r
this in console window:\r
  > SET UIQROOT2=C:\UIQ_21\\r
  > make -f picosmall.armi noecompxl=1\r
(To use ECompXL, you must rename ECompXL's petran.exe to petran_.exe or\r
edit the makefile).\r
\r
Launcher:\r
There should be far less problems building that. Simply typing\r
  > makmake PicodriveN.mmp armi\r
  > make -f PicodriveN.armi\r
in console window with launcher directory set should build it without\r
problems.\r
\r
\r
Compiling GP2X port\r
-------------------\r
If you use devkitGP2X with gcc 4.0.2 and your paths are set correctly, running\r
'make' should be enough. If you are under Linux, you may need do some\r
adjustments, like changing case of filenames or setting up paths. I am sure\r
you will figure out yourself :)\r
\r
\r
License mess\r
------------\r
The launcher for Symbian OS is based on Peter van Sebille's projects,\r
which are released under GPL (license_gpl.txt).\r
\r
YM2612 and sn76496 sound cores were taken from the MAME project, which is\r
under it's own license (license_mame.txt).\r
\r
Dave's Cyclone 68000 core, Pico library are under simple\r
"Free for non-commercial use, For commercial use, separate licencing\r
terms must be obtained" license.\r
\r
As far as I checked, both "Free for non-commercial use" and MAME licenses\r
might be incompatible with GPL, because GPL DOES allow commercial distribution.\r
But I don't think the original copyright holders (Peter, Dave, Reesy or the\r
MAME devs) would get very upset about this "violation", as this is both free\r
and open-source project. However, the whole project most likely falls under\r
GPL now (I don't know for sure as I'm just another coder, not a lawyer).\r
Alternatively, the launcher and exe can be viewed as separate programs\r
(technically this is true, they both use separate binaries, only protocol\r
is shared), so I hope nobody sees a problem here.\r
\r
\r
Contact\r
-------\r
My e-mail: notasas(atsymbol)gmail.com\r