README.en.md

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