README.md

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