OSDN Git Service

[DOC] Update documents.
[csp-qt/common_source_project-fm7.git] / source / readme_by_artane.txt
1 ** Qt porting for Common Source Code Project **
2                                          October 18, 2017
3               K.Ohta <whatisthis.sowhat _at_ gmail.com>
4
5 * If you can't read Japanese, read readme.qt.txt .
6
7 0. 概要
8    このパッケージは、Common Source Code Project (以下、CSP)
9    をQt5に移植したものです。
10    バイナリはGNU/Linux(64bit)用とMinGW (32bit Windows)用を
11    用意しています。
12    
13    ソースコード:
14    
15      https://github.com/Artanejp/common_source_project-fm7/releases/tag/SNAPSHOT_20171018
16
17    追加情報:
18    
19      各機種バイナリーは、osdn.net もしくはミラーサイトより入手可能です。
20     
21     https://osdn.net/projects/csp-qt/  
22    
23      https://osdn.net/projects/csp-qt/releases/ をチェックしてください。
24
25     Win32: 
26
27     GNU/Linux(amd64) : 
28
29 【おねがい】
30       doc/以下の文書で日本語しかなかったものを英語に翻訳していますが、機械翻訳を使ってるのであやしいです。
31      
32        英語の上手い方、校正などお願いします m(_ _)m
33
34 1. 背景
35
36    CSPは、非常に優れた構造のエミュレータです(しかし、些か重くてコンパイラ
37    がいい最適化をしないと重めですが)。
38    しかし、このコードはM$ Visual C++依存の部分が非常に多いです。
39    そこで、GNU/Linuxでこれを動かすためにQtに色々と移植していきましょう。
40    と言う感じで作業をはじめました。
41
42 2. 最低限必要なもの(Qt版)
43
44    a. Qt5 ツールキット。Qt 5.5以降を推奨します。
45    
46    b. OpenGL, 多分、最低OpenGL 2.1は必要です。(注:ひょっとしたら、OpenGLES2以降ならば動くように変えるかも知れない)
47    
48    c. gcc / g++ (5.0以降?)もしくは llvm clang / clang++ (3.5以降?)
49       コンパイラツールチェーン。
50       
51    d. SDL2 (SDL 1.xではないので注意)
52    
53    e. CMake 2.8以降。
54    
55    f. ffmpegから、libavとlibswが必要です。 http://ffmpeg.org/ より。
56    
57    g. ffmpegは、それぞれのランタイムに必要なものをバンドルしてありますので、動かない時はインストールしてみてください。
58       
59    h. GNU/Linuxビルドでは、Qt5.5(Ubuntu 16.04LTS向け)もしくはQt5.9(Debian GNU/Linux sid向け)でビルドしてあります。
60    
61    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、MinGW (gcc6) と Qt 5.7 でのビルドができることを確認しました。
62      
63    * TIPS:
64    
65      * Windows等で動かした時に、画面の書き替えが表示されない場合は、環境変数 QT_OPENGL を software にしてみてください。(例えば、
66        WindowsをVirtualBoxのゲストで使ってる場合など)
67        
68      * Windows版バイナリには、ソフトウェアレンダリングのopengl32.dllが添付されてますが、最近のパソコンの専用GPUドライバなら、
69        もっと程度のいいOpenGLが入ってるはずです。
70        添付版opengl32.dllを適当な名前に変更して動くかどうか試してみて下さい。
71      
72 3. ビルドの方法
73
74    ソースコードを解凍するか、git clone / pull した後で:
75    
76    $ cd {srctop}/source/build-cmake/{Machine name}/
77    $ mkdir build
78    $ cd build
79    
80    To configure:
81    
82    $ cmake ..
83    
84    or
85    
86    $ ccmake ..
87
88    To build:
89    
90    $ make
91
92    To install:
93    
94    $ sudo make install
95
96 4. Qt固有の話(Windows除く)
97
98    *ToolTipsを付けました。(2017-01-24)
99       
100    *日本語に翻訳しました。(2017-01-24)
101    
102    *R@Mを $HOME/emu{Machine Name}/ に配置してください。(Windowsの場合は今の所 .\emu{Machine Name}\)。なお、このディレクトリは最初起動した後で作成されます。
103    
104    *設定ファイルは、$HOME/.config/emu{Machine Name}/ に書き込まれます。(Windowsの場合は今の所 .\.config\emu{Machine Name}\)
105    
106    *ステートセーブファイルは、$HOME/emu{Machine Name}/{Machine Name}.sta に書き込まれます。
107    
108    *キーコード変換テーブルファイルが、$HOME/.config/emu{Machine Name}/scancode.cfg に書き込まれます。
109    
110      書式は、カンマで区切られた16進データです(10進ではないので注意) .
111      
112      1カラム目はM$ ヴァーチャルキーコード。
113      
114      2カラム目はQtネィティブのスキャンキーコードです。
115      
116    *UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
117    
118    *インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
119    
120    *ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
121    
122    *ローマ字カタカナ変換支援機構が一部の機種に実装されてます。romaji_kana.ja.txt をお読みください。
123     
124 5. 移植状況
125    
126    a.現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"
127      の AMD64版でしかテストしていません。
128     が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば
129     動くでしょう。
130      Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWと
131      Qt community edition でのビルドが通るようになりました。
132       
133    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなく
134       Qt5を使っています。
135       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
136
137    c. Linux用ビルドでは、GCCをリンク時最適化(LTO)モードで使っています。
138    d. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(;´Д`)
139    
140 6. Upstream repositry:
141       https://github.com/Artanejp/common_source_project-fm7
142       
143       https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7
144
145 7. Project Page:
146       https://osdn.jp/projects/csp-qt/
147
148 8. Upstream (Takeda Toshiyaさんのオリジナル) 
149       http://takeda-toshiya.my.coocan.jp/
150
151 Changes:
152
153 ChangeLog:
154 * 前の変更点をお読みになる場合には、ChangeLogをお読み下さい。
155 * SNAPSHOT Oct 18, 2017
156   * Upstream 2017-08-12.
157   * [VM/FM7] FLOPPY: Fix crash when starting.
158   * [Build/CMAKE] Fix FTBFS with USE_COMMON_DEVICE_LIB != "Yes".
159   * [Build/WIN32] MinGW: Add new cross-build script for FFMPEG-3.4 and x264-152.
160   * [Build/Linux] Add "COMPRESS_SYMBOLS" flag to configuration.
161   * [BUILD/Linux] Don't use LTO for shared libs, use compress symbols.
162   * [BUILD] Fix FTBFSs a lot.
163   * [DOC] Rename LICENSE to LICENSE.txt due to coflict to doc/license directory.This is important to release for M$ Windoze OS.
164
165 -- Oct 18, 2017 16:33:58 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
166
167 本家の変更:
168 * 前の変更点をお読みになる場合には、history.txtをお読み下さい。
169
170 8/12/2017
171
172 [EMU/DEBUGGER] improve to show message when cpu is not suspended soon
173
174 [PC8801/PC88] fix to render text color #0 with back color
175
176 [PC8801/PC88] fix to get text color attribute when text display is stopped
177
178
179 -----
180
181
182 お楽しみあれ!
183 -- Ohta.