[DOC] Update README.md.

diff --git a/README b/README
index 13db2f9..066fcad 100644 (file)
--- a/README
+++ b/README
@@ -2,6 +2,8 @@
                                            Sep 09, 2016
              K.Ohta <whatisthis.sowhat _at_ gmail.com>
 
+--- If you can't read Japanese, [english writing is here](/README.en.md/).
+
 0. About
    This package is Qt5 porting of Common Source Code Project (CSP).
    Building with GNU/Linux(64bit) and MinGW(32bit Windows).

diff --git a/README.en.md b/README.en.md
new file mode 100644 (file)
index 0000000..38f32b8
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,77 @@
+** Qt porting for Common Source Code Project **
+                                           Sep 09, 2016
+             K.Ohta <whatisthis.sowhat _at_ gmail.com>
+
+
+0. About
+   This package is Qt5 porting of Common Source Code Project (CSP).
+   Building with GNU/Linux(64bit) and MinGW(32bit Windows).
+   
+1. Background
+   Common Source Code Project (CSP) is good emulator writing.
+   But codes are specified to M$ Visual C.
+   I'm using GNU/Linux, and I starting to apply FM-7(or later).
+   So, I start to port to GNU/Linux and using Qt4.
+   
+   * Note: You can build with MinGW32 and Qt 5.5.1(for MinGW).
+
+   * TIPS: If emufoo.exe don't show screen drawing, set environment 
+           variable QT_OPENGL to software (i.e. Using Windows as VirtualBox's gueat OS).
+     
+2. What you need at least:
+   a. Qt5 (neither Qt3 and Qt4) toolkit.
+   b. Some OpenGL implementation, maybe at leaset OpenGL v3.0 .
+   c. gcc / g++ (4.7 or later? ) or llvm clang / clang++ (3.5 or later?) toolchain.
+   d. SDL2 (not SDL1.x).
+   e. CMake 2.8 or later.
+
+3. How to build:
+   After extracting (or git pulled) sourcecodes:
+   $ cd {srctop}/source/build-cmake/{Machine name}/
+   $ mkdir build
+   $ cd build
+   
+   To configure:
+   $ cmake ..
+   or
+   $ ccmake ..
+
+   To build:
+   $ make
+
+   To install:
+   $ sudo make install
+
+4.Qt specified notice (for non-Windows):
+   ・Place R@Ms under $HOME/emu{Machine Name}/ , this directory has made
+     after first using.
+   ・Config file, {foo}.ini is written on $HOME/.config/emu{Machine Name}/ .
+   ・Saved state file, {foo}.sta is written on $HOME/emu{Machine Name}/ .
+   ・Key code conversion file is written on $HOME/.config/emu{Machine Name}/scancode.cfg .
+     This file contains comma separated fields, written at hex-decimal (not decimal), 
+     first is M$ Virtual Key Code,
+     second is Qt's scan code.
+   
+5.Status
+a. I tested to build only under Debian GNU/Linux "sid".
+   But, perhaps, will succed to build another GNU/Linux OSs or BSD OS variants.
+   * On windows, using MinGW is already okay.
+   * Cross building with GNU/Linux's MinGW32 and Qt5.5.1 (for MinGW) is available. 
+     Modify and use build-cmake/config_build_cross_win32.sh and related *.cmake files.
+   * And, you can also build with M$ Visual Studio 2013 or 2015.
+   
+  b. Now, I using Qt5 as toolkit, because authors of Qt announced
+     "Qt4 is obsolete, will be updated no longer".
+
+  c. All of virtual machines of upstream (@Dec 17, 2015) are already ported to Qt.
+  d. Now using GCC-5.2 with Link Time Optimize to build for distrubuted binaries.
+
+6. Upstream repositry:
+      https://github.com/Artanejp/common_source_project-fm7
+      https://www.pikacode.com/Artanejp/common_source_project-fm7/
+      
+7. Upstream (Takeda Toshiya San's original code) 
+      http://takeda-toshiya.my.coocan.jp/
+
+Have fun!
+-- Ohta.