aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Fadel <samuelfadel@gmail.com>2015-04-01 23:05:35 -0300
committerSamuel Fadel <samuelfadel@gmail.com>2015-04-01 23:05:35 -0300
commit7067f19c8adfc404f0617a3e2d61b136d196f4cb (patch)
treebeb97500ce57ca124318b62689cb72754cfbcac6
parent3f60870cac619c0dc0b4e4eccf678efbff237369 (diff)
Updated README file.
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4f5b8e2..ef975ee 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
# T #
-
T is a lean **T**erminal emulator. The project aims to keep it as simple as
possible, while still being usable. Configuration is done by modifying the file
-`config.h` and recompiling.
+`config.h` and recompiling. It is actually two applications: one acts as a
+daemon (`Td`) while the other (`Tc`) is invoked to request new windows or kill
+the daemon. This was done so that the resource usage is (somewhat) minimized by
+keeping all terminals under the same process while new windows are opened
+(somewhat) faster.
## Compilation ##
T has the following compilation dependencies. The versions are the ones used to
@@ -19,3 +22,13 @@ To compile T, run:
To install T, run (needs superuser privileges):
make install
+
+## Usage ##
+`Td` has no invocation arguments. You just keep it running and it will listen on
+a local socket file (see `config.h`) for connections from `Tc`. `Tc` has the
+following invocation arguments:
+
+`-n`
+ Requests a new window; default if omitted
+`-x`
+ Request daemon termination; only successful if there are no open windows