OSDN Git Service

[DOC] Update documents.
[csp-qt/common_source_project-fm7.git] / source / readme.qt.txt
1 ** Qt porting for Common Source Code Project **
2                                            Apr 28, 2016
3               K.Ohta <whatisthis.sowhat _at_ gmail.com>
4
5 0. About
6    This package is Qt5 porting of Common Source Code Project (CSP).
7    Building with GNU/Linux(64bit) and MinGW(32bit Windows).
8    
9 1. Background
10    Common Source Code Project (CSP) is good emulator writing.
11    But codes are specified to M$ Visual C.
12    I'm using GNU/Linux, and I starting to apply FM-7(or later).
13    So, I start to port to GNU/Linux and using Qt4.
14    
15    * Note: You can build with MinGW32 and Qt 5.5.1(for MinGW).
16
17    * TIPS: If emufoo.exe don't show screen drawing, set environment 
18            variable QT_OPENGL to software (i.e. Using Windows as VirtualBox's gueat OS).
19      
20 2. What you need at least:
21    a. Qt5 (neither Qt3 and Qt4) toolkit.
22    b. Some OpenGL implementation, maybe at leaset OpenGL v3.0 .
23    c. gcc / g++ (4.7 or later? ) or llvm clang / clang++ (3.5 or later?) toolchain.
24    d. SDL2 (not SDL1.x).
25    e. CMake 2.8 or later.
26
27 3. How to build:
28    After extracting (or git pulled) sourcecodes:
29    $ cd {srctop}/source/build-cmake/{Machine name}/
30    $ mkdir build
31    $ cd build
32    
33    To configure:
34    $ cmake ..
35    or
36    $ ccmake ..
37
38    To build:
39    $ make
40
41    To install:
42    $ sudo make install
43
44 4.Qt specified notice (for non-Windows):
45    ・Place R@Ms under $HOME/emu{Machine Name}/ , this directory has made
46      after first using.
47    ・Config file, {foo}.ini is written on $HOME/.config/emu{Machine Name}/ .
48    ・Saved state file, {foo}.sta is written on $HOME/emu{Machine Name}/ .
49    ・Key code conversion file is written on $HOME/.config/emu{Machine Name}/scancode.cfg .
50      This file contains comma separated fields, written at hex-decimal (not decimal), 
51      first is M$ Virtual Key Code,
52      second is Qt's scan code.
53    ・Common UI components (at src/qt/gui ) are moved to shared lib. libCSPgui.so .
54    ・Installer (bash) script is available now; src/tool/installer_unix.sh .
55    
56 5.Status
57 a. I tested to build only under Debian GNU/Linux "sid".
58    But, perhaps, will succed to build another GNU/Linux OSs or BSD OS variants.
59    * On windows, using MinGW is already okay.
60    * Cross building with GNU/Linux's MinGW32 and Qt5.5.1 (for MinGW) is available. 
61      Modify and use build-cmake/config_build_cross_win32.sh and related *.cmake files.
62    * And, you can also build with M$ Visual Studio 2013 or 2015.
63    
64   b. Now, I using Qt5 as toolkit, because authors of Qt announced
65      "Qt4 is obsolete, will be updated no longer".
66
67   c. All of virtual machines of upstream (@Apr 01, 2016) excepts PX7 are already ported to Qt.
68   d. Now using GCC-6 with Link Time Optimize to build for distrubuted binaries.
69
70 6. Upstream repositry:
71       https://github.com/Artanejp/common_source_project-fm7
72       https://www.pikacode.com/Artanejp/common_source_project-fm7/
73       
74 7. Upstream (Takeda Toshiya San's original code) 
75       http://homepage3.nifty.com/takeda-toshiya/
76
77 Have fun!
78 -- Ohta.