use a website instead of a readme
This commit is contained in:
Executable → Regular
+2
-67
@@ -1,67 +1,2 @@
|
|||||||
tft - Terminal Family Tree
|
For information visit:
|
||||||
|
https://vene.volconst.com/en/tft/
|
||||||
tft is an ncurses program that 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
|
|
||||||
|
|
||||||
Eve, F # Eve is female
|
|
||||||
s: Adam # Eve's spouse is Adam
|
|
||||||
|
|
||||||
Cain
|
|
||||||
p: Adam, Eve # Cain's parents are Adam and Eve
|
|
||||||
|
|
||||||
Abel
|
|
||||||
p: - # Abel's parents are the same as the last person's (Cain)
|
|
||||||
|
|
||||||
Seth
|
|
||||||
p: -
|
|
||||||
|
|
||||||
|
|
||||||
Will produce:
|
|
||||||
|
|
||||||
├──────┬┬─────┐
|
|
||||||
│ ││ │
|
|
||||||
│ Adam ││ Eve │
|
|
||||||
│ ││ │
|
|
||||||
├──────┘└─────┘
|
|
||||||
│
|
|
||||||
├────────┬────────┐
|
|
||||||
│ │ │
|
|
||||||
├──────┐ ├──────┐ ├──────┐
|
|
||||||
│ │ │ │ │ │
|
|
||||||
│ Cain │ │ Abel │ │ Seth │
|
|
||||||
│ │ │ │ │ │
|
|
||||||
└──────┘ └──────┘ └──────┘
|
|
||||||
|
|
||||||
|
|
||||||
DEPENDENCIES:
|
|
||||||
ncursesw development library (libncursesw5-dev on Debian/Ubuntu)
|
|
||||||
|
|
||||||
HOW TO INSTALL:
|
|
||||||
Make sure you satisfy the dependencies and execute:
|
|
||||||
git clone https://gitlab.com/venelin98/tft.git
|
|
||||||
cd tft
|
|
||||||
sudo ./install.sh
|
|
||||||
|
|
||||||
|
|
||||||
HOW TO USE:
|
|
||||||
tft ${MY_TFT_FILE}
|
|
||||||
|
|
||||||
Navigation:
|
|
||||||
arrows - move the camera
|
|
||||||
h, j, k, l - move around the tree
|
|
||||||
Enter, Space - display the selected person's tree
|
|
||||||
+ - show full names
|
|
||||||
- - show first names only
|
|
||||||
|
|
||||||
TFT FORMAT:
|
|
||||||
- A number after a name is used to disambiguate when multiple people have identical names e.g.:
|
|
||||||
"Adam 0" is the first added Adam, "Adam 1" is the second added Adam
|
|
||||||
|
|
||||||
QUESTIONS AND FEEDBACK:
|
|
||||||
venelin98@abv.bg
|
|
||||||
|
|||||||
Reference in New Issue
Block a user