OSDN Git Service

[Qt][DRAW_THREAD] More adjust scheduler.
[csp-qt/common_source_project-fm7.git] / README.md
index 53fbff7..7e2538b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
 <H2>** Qt porting for Common Source Code Project **</H2>
 <div align="right">
-<H3>Sep 09, 2016<BR>
+<H3>Feb 10, 2018<BR>
 K.Ohta <whatisthis.sowhat _at_ gmail.com></H3>
 </div>
 
-*If you can't read Japanese, [english writing is here](/README.en.md/).*
+## *If you can't read Japanese, [english writing is here](/README.en.md/).*
+
 
 概要
 ======
@@ -13,61 +14,69 @@ K.Ohta <whatisthis.sowhat _at_ gmail.com></H3>
    
    バイナリはGNU/Linux(64bit)用とMinGW (32bit Windows)用を用意しています。
    
-   ソースコード:
+## ソースコード
    
-     https://github.com/Artanejp/common_source_project-fm7/ 以下
-
-###追加情報:
+<https://github.com/Artanejp/common_source_project-fm7/> 以下
 
+## 追加情報
    
 各機種バイナリーは、osdn.net もしくはミラーサイトより入手可能です。
     
-    https://osdn.net/projects/csp-qt/  
+<https://osdn.net/projects/csp-qt/>  
    
-    https://osdn.net/projects/csp-qt/releases/
+<https://osdn.net/projects/csp-qt/releases/>
 
 をチェックしてください。
 
-###【おねがい】
-
+## 【おねがい】
 
 doc/以下の文書で日本語しかなかったものを英語に翻訳していますが、機械翻訳を使ってるのであやしいです。英語の上手い方、校正などお願いします m(_ _)m
 
-##1. 背景
+LICENSE
+======
 
-   CSPは、非常に優れた構造のエミュレータです(しかし、些か重くてコンパイラがいい最適化をしないと重めですが)。
-   
-   しかし、このコードはM$ Visual C++依存の部分が非常に多いです。
+[GPL Version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.ja.html)
+
+[GPL Version 2 和訳](http://www.opensource.jp/gpl/gpl.ja.html)
 
-   そこで、GNU/Linuxでこれを動かすためにQtに色々と移植していきましょう。と言う感じで作業をはじめました。
+背景
+====
 
-##2. 最低限必要なもの(Qt版)
+CSPは、非常に優れた構造のエミュレータです(しかし、些か重くてコンパイラがいい最適化をしないと重めですが)。
 
-   a. Qt5 ツールキット。Qt 5.5以降を推奨します。
+しかし、このコードはM$ Visual C++依存の部分が非常に多いです。
+
+そこで、GNU/Linuxでこれを動かすためにQtに色々と移植していきましょう。と言う感じで作業をはじめました。
+
+最低限必要なもの(Qt版)
+====
+
+   * Qt5 ツールキット。Qt 5.5以降を推奨します。
    
-   b. OpenGL, 多分、最低OpenGL 2.1は必要です。(注:ひょっとしたら、OpenGLES2以降ならば動くように変えるかも知れない)
+   * OpenGL, 多分、最低OpenGL 2.1は必要です。(注:ひょっとしたら、OpenGLES2以降ならば動くように変えるかも知れない)
    
-   c. gcc / g++ (5.0以降?)もしくは llvm clang / clang++ (3.5以降?)コンパイラツールチェーン。MS Visual StudioのC++でも大体はビルドできると思いますが、未確認。
+   * gcc / g++ (5.0以降?)もしくは llvm clang / clang++ (3.5以降?)コンパイラツールチェーン。MS Visual StudioのC++でも大体はビルドできると思いますが、未確認。
       
-   d. SDL2 (SDL 1.xではないので注意)
+   * SDL2 (SDL 1.xではないので注意)
    
-   e. CMake 2.8以降。
+   * CMake 2.8以降。
    
-   f. ffmpegから、libavとlibswが必要です。 http://ffmpeg.org/ より。
+   * ffmpegから、libavとlibswが必要です。 http://ffmpeg.org/ より。
    
-   g. ffmpegは、それぞれのランタイムに必要なものをバンドルしてありますので、動かない時はインストールしてみてください。
+   * ffmpegは、それぞれのランタイムに必要なものをバンドルしてありますので、動かない時はインストールしてみてください。
       
-   h. GNU/Linuxビルドでは、Qt5.5(Ubuntu 16.04LTS向け)もしくはQt5.9(Debian GNU/Linux sid向け)でビルドしてあります。
-   
+   * GNU/Linuxビルドでは、Qt5.5(Ubuntu 16.04LTS向け)もしくはQt5.9(Debian GNU/Linux sid向け)でビルドしてあります。
+
    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、MinGW (gcc6) と Qt 5.7 でのビルドができることを確認しました。
      
-   * TIPS:
+## TIPS:
    
    * Windows等で動かした時に、画面の書き替えが表示されない場合は、環境変数 QT_OPENGL を software にしてみてください。(例えば、WindowsをVirtualBoxのゲストで使ってる場合など)
+ * Windows等で動かした時に、画面の書き替えが表示されない場合は、環境変数 QT_OPENGL を software にしてみてください。(例えば、WindowsをVirtualBoxのゲストで使ってる場合など)
        
    * Windows版バイナリには、ソフトウェアレンダリングのopengl32.dllが添付されてますが、最近のパソコンの専用GPUドライバなら、もっと程度のいいOpenGLが入ってるはずです。添付版opengl32.dllを適当な名前に変更して動くかどうか試してみて下さい。
+ * Windows版バイナリには、ソフトウェアレンダリングのopengl32.dllが添付されてますが、最近のパソコンの専用GPUドライバなら、もっと程度のいいOpenGLが入ってるはずです。添付版opengl32.dllを適当な名前に変更して動くかどうか試してみて下さい。
      
-##3. ビルドの方法
+ビルドの方法
+==
 
 ソースコードを解凍するか、git clone / pull した後で:
    
@@ -91,66 +100,73 @@ To install:
    
     $ sudo make install
 
-##4. Qt固有の話(Windows除く)
+## Qt固有の話
 
-   *ToolTipsを付けました。(2017-01-24)
-      
-   *日本語に翻訳しました。(2017-01-24)
-   
-   *R@Mを $HOME/emu{Machine Name}/ に配置してください。(Windowsの場合は今の所 .\emu{Machine Name}\)。なお、このディレクトリは最初起動した後で作成されます。
-   
-   *設定ファイルは、$HOME/.config/emu{Machine Name}/ に書き込まれます。(Windowsの場合は今の所 .\.config\emu{Machine Name}\)
+   * 設定ファイル(scancode.cfg と foo.ini)は、"~/.config/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます(移動しました)。
+
+   * BIOSや効果音WAVやセーブステートは、、"~/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます(移動しました)。
    
-   *ステートセーブファイルは、$HOME/emu{Machine Name}/{Machine Name}.sta に書き込まれます。
+   * 全ての記録物(スクリーンショットや動画や録音WAV)は、*当面の間* "~/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます。
+
+   * ToolTipsを付けました。(2017-01-24)
+      
+   * 日本語に翻訳しました。(2017-01-24)
    
-   *キーコード変換テーブルファイルが、$HOME/.config/emu{Machine Name}/scancode.cfg に書き込まれます。
+   * R@Mを $HOME/CommonSourceCodeProject/emu{Machine Name}/ に配置してください。(Windowsの場合は今の所 .\CommonSourceCodeProject\emu{Machine Name}\)。なお、このディレクトリは最初起動した後で作成されます。
+      
+   * キーコード変換テーブルファイルが、$HOME/.config/CommonSourceCodeProject/emu{Machine Name}/scancode.cfg に書き込まれます。
    
-     書式は、カンマで区切られた16進データです(10進ではないので注意) .
+     ** 書式は、カンマで区切られた16進データです(10進ではないので注意) .
      
-     1カラム目はM$ ヴァーチャルキーコード。
+     ** 1カラム目はM$ ヴァーチャルキーコード。
      
-     2カラム目はQtネィティブのスキャンキーコードです。
+     ** 2カラム目はQtネィティブのスキャンキーコードです。
      
-   *UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
+   * UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
    
-   *インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
+   * インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
    
-   *ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
+   * ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
    
-   *ローマ字カタカナ変換支援機構が一部の機種に実装されてます。romaji_kana.ja.txt をお読みください
+   * ローマ字カタカナ変換支援機構が一部の機種に実装されてます
     
-##5. 移植状況
-   
-   a.現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"の AMD64版、後はWindowsのMinGWでしかテストしていません。
+移植状況
+==
+
+   * 現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"の AMD64版、後はWindowsのMinGWでしかテストしていません。
    
     が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば動くでしょう。
    
      Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWとQt community edition でのビルドが通るようになりました。
       
-   b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなくQt5を使っています。
+   * 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなくQt5を使っています。
    
       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
 
-   c. Linux用ビルドでは、GCCをリンク時最適化(LTO)モードで使っています。
+   * Linux用ビルドでは、GCCをリンク時最適化(LTO)モードで使っています。
    
-   d. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(;´Д`)
+   * MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(;´Д`)
    
-##6. Upstream repositry:
+Upstream repositry:
+==
 
-      https://github.com/Artanejp/common_source_project-fm7
+<https://github.com/Artanejp/common_source_project-fm7>
       
-      https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7
+<https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7>
 
-##7. Project Page:
+Project Page:
+==
 
-      https://osdn.jp/projects/csp-qt/
+<https://osdn.jp/projects/csp-qt/>
 
-##8. Upstream (Takeda Toshiyaさんのオリジナル)
+Upstream (Takeda Toshiyaさんのオリジナル)
+==
 
-      http://takeda-toshiya.my.coocan.jp/
+<http://takeda-toshiya.my.coocan.jp/>
 
 
-##Special thanks to:
+Special thanks to:
+==
 
   Ryu Takegami : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 
@@ -158,4 +174,7 @@ Have fun!
 
 --- Ohta.
  
-   
+&copy; 2018 Toshiya Takeda
+
+&copy; 2018 K.Ohta <whatisthis.sowhat _at_ gmail.com>
+