Chinese README.md

1 files changed, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d2f8b7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+FQTerm
+======
+FQTerm是为Telnet BBS设计的终端模拟器，支持Telnet,SSH协议。
+
+本项目源自QTerm-Qt3,从2008年起，由Curvlet和dp2重写并移植至Qt4.
+
+现在FQTerm的原开发组成员已经停止了该项目的维护，现由ArchLinux@newsmth
+维护并进行Qt5的移植。
+
+如何贡献源码
+============
+在fork本项目，然后自己开发，提交自己的更改，再创建pull request.
+详情请看GitHub的帮助:
+- https://help.github.com/articles/fork-a-repo
+- https://help.github.com/articles/using-pull-requests
+
+TODO
+====
+- ~~Bug: Qt5分支中Ctrl按键异常 (暂时使用Mac OS的处理方法解决)~~
+- Bug: Qt5分支中退出时SIGSEGV
+- ~~Maybe something wrong with imageviewer (Qt5)~~
+- 考虑代码重构
+- Bug: 处理不完整GBK字符时存在一些异常，特别是在Qt5分支
+
+安装
+=======
+获取代码：      
+```
+git clone https://github.com/mytbk/fqterm.git
+```
+要用Qt5分支，可以在使用 ```--branch Qt5``` 参数，即：
+```
+git clone https://github.com/mytbk/fqterm.git --branch Qt5
+```
+然后开始编译：      
+
+```
+# 假设FQTerm源码目录为fqterm
+mkdir build
+cd build
+cmake ../fqterm
+make
+# 以root身份安装，以下用sudo获取root权限
+sudo make install
+```
+
+Windows版本
+==============
+- 在Linux下用MXE交叉编译，运行时错误，可能原因是MXE的Qt缺少语言Codec
+- MinGW: 正常编译及运行
+- MSVC: 未测试