Update README.md

README.md

@@ -1 +1,22 @@
-# SingingPiano
+# SingingPiano
+[中文版](docs/README-zh_CN.md)
+## Tutorials
+
+### Supported Platform
+* Windows 10 (64 bit version) 
+* Linux (64 bit version) [UNCHECKED]
+* Android [PARTIAL]
+* OS X [UNCHECKED]
+
+### Installation
+0. Obtain [Python](https://python.org);
+0. Use <code>pip -r requirments.txt</code> to install all the requirements for this tool;
+0. For non-windows users: Manually build the [native module](libs/mydft), here is the command: (under the source directory)<code>python3 setup.py build</code>, and put the binary module file into the [libs](libs) directory;
+0. Run [SingingpianoQt.pyw](SingingpianoQt.pyw) and enjoy!
+
+### Troubleshooting
+#### Unable to open "SingingpianoQt.pyw"
+* Make sure that you have done the former installation steps successfully;
+* Use [QTDEBUG.BAT](QTDEBUG.BAT)(windows user) or <code>python3 SingingpianoQt.pyw</code>(in "terminal" window) to start the tool, if any error occured, come up with a new issue [here](https://github.com/wave2midi/SingingPiano/issues/new).
+
+

docs/README-zh_CN.md

@@ -0,0 +1,22 @@
+# SingingPiano
+
+## 教程
+
+### 支持平台
+* Windows 10 (64位) 
+* Linux (64位) [未经验证]
+* Android [部分]
+* OS X [未经验证]
+
+### 安装步骤
+0. 取得 [Python](https://python.org);
+0. 使用 <code>pip -r requirments.txt</code> 安装所有必需依赖库;
+0. 非Windows用户: 用如下命令手动构建[本地库](libs/mydft): (在其源代码目录下)<code>python3 setup.py build</code>, 并将编译好的二进制模块文件放入[libs](libs)目录;
+0. 运行[SingingpianoQt.pyw](SingingpianoQt.pyw), 大功告成!
+
+### 遇到问题？
+#### 无法打开 "SingingpianoQt.pyw"
+* 确保你完成了以上的安装步骤;
+* 用[QTDEBUG.BAT](QTDEBUG.BAT)(windows 用户)或<code>python3 SingingpianoQt.pyw</code>(in "terminal" window)打开工具, 如果发生错误, 在[这里](https://github.com/wave2midi/SingingPiano/issues/new)提一个issue.
+
+