README.en.md

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