aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 15 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1add2bf
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+
+gterm
+=====
+
+Terminal application, based on gtk3 and vte. The plan is to have a
+modern terminal (which runs on wayland for example) for xterm fans.
+
+Command line options are compatible with xterm. Likewise config file
+key naming follows xterm resource naming. No config UI, you have to
+edit the ~/.config/gterm.conf config file, simliar to editing
+~/.Xdefaults for xterm.
+
+The number of supported config options is rather small right now, but
+is expected to grow over time to cover the most important ones. It
+will probably never fully match the xterm feature set though.