summaryrefslogtreecommitdiff
path: root/README_en.md
diff options
context:
space:
mode:
authorIru Cai <mytbk920423@gmail.com>2014-06-05 16:58:10 +0800
committerIru Cai <mytbk920423@gmail.com>2014-06-05 16:58:10 +0800
commit8e6b48eb1cd8e33cd05b6a766fc374c1358c3f05 (patch)
tree88861e22ec20a2002c51cd40340d10493b8e2218 /README_en.md
parent60c1e9e08f37c57afe651e213014f50472157e39 (diff)
downloadfqterm-8e6b48eb1cd8e33cd05b6a766fc374c1358c3f05.tar.xz
rename readme file
Diffstat (limited to 'README_en.md')
-rw-r--r--README_en.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/README_en.md b/README_en.md
new file mode 100644
index 0000000..f0451af
--- /dev/null
+++ b/README_en.md
@@ -0,0 +1,42 @@
+FQTerm
+======
+This is a terminal simulator developed for telnet based online forum.
+
+Originally forked from Qterm-Qt3, rewritten and ported to Qt4 by Curvlet and dp2 since 2008.
+
+Now I'm porting FQTerm to Qt5.
+
+TODO
+====
+- ~~Bug fix: Unable to use Ctrl key (FIXED using the code for Mac OS)~~
+- Bug fix: SIGSEGV on exit (Qt5)
+- Maybe something wrong with imageviewer (Qt5)
+- Reconstruct the code
+- Some stinky things with wide characters (Qt5)
+
+Install
+=======
+First clone the code.
+```
+git clone https://github.com/mytbk/fqterm.git
+```
+If you want to use the Qt5 branch, just add ```--branch Qt5``` as
+follows.
+```
+git clone https://github.com/mytbk/fqterm.git --branch Qt5
+```
+Then build FQTerm.
+
+```
+mkdir build
+cd build
+cmake ../fqterm
+make
+as-root make install
+```
+
+Windows Builds
+==============
+- Cross compile on Linux with MXE: builds but fails at runtime
+- MinGW on Windows: builds and runs with shared Qt 4.8.6
+- MSVC: not tested