initial release

2023-03-01 10:10:39 +02:00
parent b9151efc13
commit 199a8b527c
6 changed files with 71 additions and 52 deletions
@@ -0,0 +1,53 @@
+tft - Terminal Family Tree
+
+tft can create and display family trees on the terminal.
+
+
+HOW TO CREATE:
+
+Trees are created using the tft file format, for example this tft file:
+
+# This is a comment
+Adam, M               # Adam is a male
+
+Eve, F
+s: Adam              # Eve's spouse is Adam
+
+Cain, M
+p: Adam, Eve         # Cain's parents are Adam and Eve
+
+Abel, M
+p: -                 # Abel's parents are the same as the last person's (Cain)
+
+Seth, M
+p: -
+
+
+Will produce:
+
+├──────┬┬─────┐
+│      ││     │
+│ Adam ││ Eve │
+│      ││     │
+├──────┘└─────┘
+│
+├────────┬────────┐
+│        │        │
+├──────┐ ├──────┐ ├──────┐
+│      │ │      │ │      │
+│ Cain │ │ Abel │ │ Seth │
+│      │ │      │ │      │
+└──────┘ └──────┘ └──────┘
+
+
+
+HOW TO INSTALL:
+
+Make sure you have permissons and execute:
+	git clone https://gitlab.com/venelin98/tft.git
+	./install.sh
+
+
+HOW TO USE:
+
+	tft ${MY_TFT_FILE}