aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjakobst1n <jakob.stendahl@outlook.com>2024-06-25 22:21:48 +0200
committerjakobst1n <jakob.stendahl@outlook.com>2024-06-25 22:21:48 +0200
commit93d64ae68b2ee271b3a8215c50925f492778e5ef (patch)
tree5ad700b27c0d06345def609f5ef09145e6870505 /README.md
parentc82432863462bc893b5e1cc2e56fe1bfa9f4ba23 (diff)
downloadtextgraph-93d64ae68b2ee271b3a8215c50925f492778e5ef.tar.gz
textgraph-93d64ae68b2ee271b3a8215c50925f492778e5ef.zip
Remove dependency on libc crate
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index b70679b..b456a05 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,22 @@ sudo install target/release/textgraph /usr/local/bin/textgraph
sudo install textgraph.1 /usr/share/man/man1/textgraph.1
```
+### Features
+
+By default `libc` and `ansi` is enabled.
+
+The `libc` feature makes the program able to get the terminal size,
+and catch signals like SIGINT.
+The last part is needed if you want the program to use the alternate screen
+in filter-mode.
+It does not currently use the `libc`-crate, but it does use c-functions.
+
+The `ansi` feature enables the use of ansi escape codes,
+this is used for manipulating the terminal.
+Like adding colors to the graph,
+and switching back and fourth from the alternate screen
+(this will only happen when `libc` also is enabled).
+
## Example 1
Some examples of the different modes, from the same input file with random numbers
### Star mode