aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjakobst1n <jakob.stendahl@outlook.com>2024-06-12 01:23:56 +0200
committerjakobst1n <jakob.stendahl@outlook.com>2024-06-12 01:23:56 +0200
commitd62459369992b2ad7824a55b1736a22de4188b1a (patch)
treea32cce8adc2429ffe716dbb553b5c4cb9e574a18
parent68fb5ef079b8c122acde3252b713dd9c89d8aa5f (diff)
downloadtextgraph-d62459369992b2ad7824a55b1736a22de4188b1a.tar.gz
textgraph-d62459369992b2ad7824a55b1736a22de4188b1a.zip
Add some examples to the readme
-rw-r--r--README.md79
1 files changed, 79 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6f5046c..056fa4d 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,82 @@ watch some state in a sql table for a short while.
The documentation is in the manual file `tg.1`.
It is only tested with glibc and terminals with ansi escape code support.
+
+
+## Example 1
+Some examples of the different modes, from the same input file with random numbers
+### Star mode
+```
+100┌─────────────────────────────────────────────┐
+89 │ * * │
+79 │ * * * ** │
+68 │ ** * * │
+58 │ * * * * * * * │
+47 │ * * * * * **│
+37 │* * *** * * * * * │
+26 │ * * * * * │
+16 │ ** * * * │
+5 └─────────────────────────────────────────────┘
+```
+### Ascii mode
+```
+100┌─────────────────────────────────────────────┐
+89 │ ╭╮ ╭╮ │
+79 │ ││╭╮ ╭╮ ╭╮ ╭─╮ ││ │
+68 │ ╭─╯│││ ╭╯│ ││ ╭╮ │ │ ││ │
+58 │╭╮ ╭╮ │ ││╰╮ │ │ ╭╮││ │╰╮│ │ ╭╮ ╭╯│ │
+47 ││╰╮ │╰╮│ ││ ╰╮│ │ │││╰╮ │ ││ ╰╮││ │ │╭──┤
+37 ├╯ │ │ ╰╯ ││ ││ ╰──╯╰╯ │ ╭╮│ ╰╯ ╰╯│ │ ╰╯ │
+26 │ ╰╮ │ ╰╯ ╰╯ │╭╯││ │╭╯ │
+16 │ ╰─╯ ╰╯ ╰╯ ╰╯ │
+5 └─────────────────────────────────────────────┘
+```
+### Braille mode (Probably the most buggy mode)
+```
+100┌────────────────────┐
+89 │ ⠄⠂ │
+79 │ ⠄ │
+68 │ ⠠ ⠂ ⠠ │
+58 │⠠ ⠠ ⠄ ⠂⠠ │
+47 │ ⠄ ⠂ ⠂│
+37 │ ⠠ ⠂ ⠄ ⠐ ⠠ ⠐ │
+26 │ ⠠ ⠂ ⠂ │
+16 │⠂ ⠠ ⠂ ⠐ │
+5 └────────────────────┘
+```
+
+## Example 2
+Example of a simple sinusoid
+### Star
+10 ┌──────────────────────────────────────────────────────────────────────┐
+8 │ ********** │
+6 │ ***** ***** │
+3 │ *** *** │
+1 │ *** *** │
+-1 │ *** *** │
+-3 │ *** *** │
+-6 │ **** **** │
+-8 │******** **********│
+-10└──────────────────────────────────────────────────────────────────────┘
+### Ascii
+10 ┌──────────────────────────────────────────────────────────────────────┐
+8 │ ╭─────────╮ │
+6 │ ╭────╯ ╰────╮ │
+3 │ ╭──╯ ╰──╮ │
+1 │ ╭──╯ ╰──╮ │
+-1 │ ╭──╯ ╰──╮ │
+-3 │ ╭──╯ ╰──╮ │
+-6 │ ╭───╯ ╰───╮ │
+-8 ├───────╯ ╰──────────┤
+-10└──────────────────────────────────────────────────────────────────────┘
+### Braille
+10 ┌───────────────────────────────────┐
+8 │ ⠐⠢⠄ ⠠⠔⠂ │
+6 │ ⠢ ⠔ │
+3 │ ⠐⠄ ⠠⠂ │
+1 │ ⠢ ⠔ │
+-1 │ ⠂ ⠐ │
+-3 │ ⠐⠄ ⠠⠂ │
+-6 │ ⠐⠢ ⠔⠂ │
+-8 │⠒⠒⠒⠤ ⠤⠒⠒⠒⠤│
+-10└───────────────────────────────────┘