README.en.md

   1 <H2>** Qt porting for Common Source Code Project **</H2>
   2 <div align="right">
   3 <H3>Sep 09, 2016<BR>
   4 K.Ohta <whatisthis.sowhat _at_ gmail.com></H3>
   5 </div>
   6
   7 ## *If you can read Japanese, [japanese(日本語) writing is here](/README.md/).*
   8
   9
  10 About
  11 ====
  12
  13    This package is Qt5 porting of Common Source Code Project (CSP).
  14
  15    Building with GNU/Linux(64bit) and MinGW(32bit Windows).
  16
  17 ## Source code
  18
  19 <https://github.com/Artanejp/common_source_project-fm7/>
  20
  21 ## Additional infomations
  22
  23 You can get pre-compiled binaries from [osdn.net](http://osdn.net) and their mirrors.
  24
  25 <https://osdn.net/projects/csp-qt/>
  26
  27 <https://osdn.net/projects/csp-qt/releases/>
  28
  29
  30 LICENSE
  31 ======
  32
  33 [GPL Version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
  34
  35 Background
  36 ==========
  37
  38 Common Source Code Project (CSP) is good emulator writing.
  39
  40 But codes are specified to M$ Visual C.
  41
  42 I'm using GNU/Linux, and I starting to apply FM-7(or later).
  43
  44 So, I start to port to GNU/Linux and using Qt4.
  45
  46 ## Note:
  47
  48 You can build with MinGW32 and Qt 5.5.1(for MinGW).
  49
  50 TIPS:
  51
  52 * If emufoo.exe don't show screen drawing, set environment variable QT_OPENGL to software (i.e. Using Windows as VirtualBox's gueat OS).
  53
  54 What you need at least:
  55 =====
  56
  57 * Qt5 (neither Qt3 and Qt4) toolkit.
  58
  59 * Some OpenGL implementation, maybe at leaset OpenGL v3.0 .
  60
  61 * gcc / g++ (5.4 or later? ) or llvm clang / clang++ (3.5 or later?) toolchain.
  62
  63 * SDL2 (not SDL1.x).
  64
  65 * CMake 2.8 or later.
  66
  67 How to build:
  68 =====
  69
  70 After extracting (or git pulled) sourcecodes:
  71
  72     $ cd {srctop}/source/build-cmake/{Machine name}/
  73     $ mkdir build
  74     $ cd build
  75
  76 *To configure:*
  77
  78     $ cmake ..
  79
  80  or
  81
  82     $ ccmake ..
  83
  84 *To build:*
  85
  86     $ make
  87
  88 *To install:*
  89
  90     $ sudo make install
  91
  92 Qt specified notice (for non-Windows):
  93 ====
  94
  95 * Added ToolTips.(2017-01-24)
  96
  97 * Translated menu entries to Japanese.(2017-01-24)
  98
  99 * Place R@Ms under $HOME/emu{Machine Name}/ , this directory has made after first using.
 100
 101 * Config file, {foo}.ini is written on $HOME/.config/emu{Machine Name}/ .
 102
 103 * Saved state file, {foo}.sta is written on $HOME/emu{Machine Name}/ .
 104
 105 * Key code conversion file is written on $HOME/.config/emu{Machine Name}/scancode.cfg .
 106
 107   ** This file contains comma separated fields, written at hex-decimal (not decimal),
 108
 109   ** First is M$ Virtual Key Code,
 110
 111   ** Second is Qt's scan code.
 112
 113 * Common components (i.e. source/src/qt/gui ) are packed to DLLs/shared libs.
 114
 115 * Bash script for installation is available: source/src/tool/installer_unix.sh .
 116
 117 * When you place some WAV files to directry same as R@M, you can some sounds; i.e. FDD's seek.See doc/VMs/*.txt .
 118
 119 * ROMAJI-KANA conversion assitance feature has implemented to some VMs.
 120
 121 Status
 122 ====
 123
 124 * I tested to build only under Debian GNU/Linux "sid".But, perhaps, will succed to build another GNU/Linux OSs or BSD OS variants.
 125
 126   ** On windows, using MinGW is already okay.
 127
 128   ** Cross building with GNU/Linux's MinGW32 and Qt5.5.1 (for MinGW) is available.
 129
 130   ** Modify and use build-cmake/config_build_cross_win32.sh and related *.cmake files.
 131
 132   ** And, you can also build with M$ Visual Studio 2013 or 2015.
 133
 134 * Now, I using Qt5 as toolkit, because authors of Qt announced "Qt4 is obsolete, will be updated no longer".
 135
 136 * All of virtual machines of upstream (@Dec 17, 2015) are already ported to Qt.
 137
 138 * Now using GCC-7.x with Link Time Optimize to build for distrubuted binaries.
 139
 140 * Implemented MZ-2500's socket, but, still not test enough(；´Д｀)
 141
 142 Repositry:
 143 ===
 144
 145 <https://github.com/Artanejp/common_source_project-fm7>
 146
 147 <https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7>
 148
 149 Project Page:
 150 ==
 151
 152 <https://osdn.jp/projects/csp-qt/>
 153
 154 Upstream (Takeda Toshiya San's original code)
 155 ====
 156
 157 <http://takeda-toshiya.my.coocan.jp/>
 158
 159 Special thanks to:
 160 ==
 161
 162   Ryu Takegami : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 163
 164 Have fun!
 165
 166 --- Ohta.
 167
 168 &copy; 2018 Toshiya Takeda
 169
 170 &copy; 2018 K.Ohta <whatisthis.sowhat _at_ gmail.com>
 171