From 34fc09fa8da02a5d418adfa956abe6f3ff7f2c4b Mon Sep 17 00:00:00 2001
From: kingToolbox <51009775+kingToolbox@users.noreply.github.com>
Date: Fri, 11 Oct 2019 21:24:55 +0000
Subject: [PATCH] Add shortcuts, perfomance and latency.

---
 README.md | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 132 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0d864d6..2a7c6c1 100644
--- a/README.md
+++ b/README.md
@@ -20,5 +20,136 @@ _Hello WindTerm :rose:, hello world!_
 - All vttest tests have passed except Tektronix 4014.
 - High performance, low memory, low latency.
 
+# Shortcuts
+
+| Shortcut | Action |
+| --- | --- |
+| Alt+C | Copy |
+| Alt+D | Show command palette |
+| Alt+F | Find |
+| Alt+F3 | Find next |
+| Alt+Shift+F3 | Find previous |
+| Alt+F4 | Exit |
+| Alt+M, Alt+F | Toggle full screen |
+| Alt+M, Alt+H | Toggle hex view |
+| Alt+N | New session |
+| Alt+O | Open session |
+| Alt+S | Save text |
+| Alt+T, Alt+B | Toggle margin blank |
+| Alt+T, Alt+F | Toggle margin fold |
+| Alt+T, Alt+N | Toggle margin number |
+| Alt+T, Alt+S | Toggle margin symbol |
+| Alt+V | Paste |
+| Alt+W, Alt+D | Close active dock |
+| Alt+W, Alt+G | Close active group |
+| Alt+W, Alt+H | Split horizontally |
+| Alt+W, Alt+L | Show outline pane |
+| Alt+W, Alt+V | Split vertically |
+| Alt+X | Copy and paste |
+| Alt+- | Zoom in |
+| Alt++ | Zoom out |
+| Alt+\[ | Activate next view |
+| Alt+] | Activate previous view |
+| Ctrl+. | Jump to next fold |
+| Ctrl+, | Jump to previous fold |
+| Ctrl+Shift+A | Select all text |
+| Ctrl+Shift+T | Reopen closed session |
+| Ctrl+Shift+W | Close current session |
+| Ctrl+Shift+- | Select current fold text |
+| Shift+Del | Copy |
+| Shift+End | Jump to document end |
+| Shift+Home | Jump to document home |
+| Shift+Ins | Paste |
+| Shift+PgDown | Jump to next page |
+| Shift+PgUp | Jump to previous page |
+
+# Performance
+
+The hardware used for generating the data in these benchmarks was
+
+    windows 10 - 2.3 GHz Intel Core i5 and 8GB memory.
+
+All tests are performed on WSL(Ubuntu 18.04.2). And no color scheme used in windterm. Color scheme will result in approximately 2% loss and more memory usage.
+
+- 97.6MB random text (102,401,504 bytes, 1,329,878 lines, generated and tested by [random_test.sh](https://github.com/kingToolbox/WindTerm/blob/master/benchmark/urandom_test.sh))
+
+In all cases, three runs were made to warm system caches. The reported numbers are the median of five runs. 
+
+1. Telnet:
+
+| | Lines of scrollback | Data Rate(MB/sec) | Memory Usage(MB) |
+| --- | --- | --- | --- |
+| WindTerm | unlimited | **51.6** | **98.5** |
+| rxvt | 1,350,000 | 37.8 | 842.2 | 
+| Putty | 1,350,000 | 4.9 | 733.4 |
+| xterm | 1,350,000 | 2.2 | 3328.4 |
+
+2. SSH:
+
+| | Lines of scrollback | Data Rate(MB/sec) | Memory Usage(MB) |
+| --- | --- | --- | --- |
+| WindTerm | unlimited | **50.5** | **98.1** |
+| rxvt | 1,350,000 | 40.2 | 842.2 | 
+| Putty | 1,350,000 | 4.8 | 734.9 |
+| xterm | 1,350,000 | 2.3 | 3328.4 |
+
+- time seq 1 n
+
+1. n = 1,000,000, scrollback = 1,000,000 Lines
+
+| | Time(sec) | Memory Usage(MB) |
+| --- | --- | --- |
+| WindTerm | **1.141** | **10.6** |
+| rxvt | 5.082 | 633.3 |
+| putty | 4.161 | 551.1 |
+| xterm | 40.421 | 2500.7 |
+
+2. n = 2,000,000, scrollback = 2,000,000 Lines
+
+| | Time(sec) | Memory Usage(MB) |
+| --- | --- | --- |
+| WindTerm | **2.053** | **16.0** |
+| rxvt | 10.896 | 1266.6 |
+| putty | 16.045 | 1102.6 |
+| xterm | 68.154 | 5005.5 |
+
+3. n = 5,000,000 scrollback = 5,000,000 Lines
+
+| | Time(sec) | Memory Usage(MB) |
+| --- | --- | --- |
+| WindTerm | **4.839** | **38.7** |
+| rxvt | 27.533 | 3166.2 |
+| putty | 45.911 | 2757.1 |
+| xterm | - | Out of memmory |
+
+4. n = 10,000,000 scrollback = 10,000,000 Lines
+
+| | Time(sec) | Memory Usage(MB) |
+| --- | --- | --- |
+| WindTerm | **9.576** | **78.6** |
+| rxvt | - | Out of memory |
+| putty | - | Out of memory |
+| xterm | - | Out of memmory |
+
+5. n = 10,000,000 scrollback = 30 Lines
+
+| | Time(sec) | Memory Usage(MB) |
+| --- | --- | --- |
+| WindTerm | **9.514** | 2.2 |
+| rxvt | 9.687 | **0.1** |
+| putty | 95.382 | 0.4 |
+| xterm | 286.510 | **0.1** |
+
+# Latency
+
+Considering the network influence on the latency, the following data is from [DIGEdit](https://github.com/kingToolbox/digedit).
+DIGEdit is the text component of WindTerm.
+
+|   | Min | Max | Avg | SD |
+| --- | --- | --- | --- | --- |
+|DIGEdit| 1.9 | 7.6 | 2.9 | 0.8 |
+|Windows Notepad | 0.9 | 16.5 | 7.8 | 1.8 |
+|GVim | 0.9 | 10.4 | 2.8 | 1.2 |
+
 # License
-Free for personal use. Currently limited to a maximum of sixteen sessions.
+Free for personal use. Currently limited to a maximum of 16 sessions.