local instructions

2023-11-02 21:25:56 +02:00
parent 6a71d7e13c
commit bc5e5d1deb
11 changed files with 210 additions and 166 deletions
@@ -0,0 +1,62 @@
+tft - Terminal Family Tree
+==========================
+tft is an ncurses program that can create and display family trees on the terminal.
+
+Webpage
+-------
+https://vene.volconst.com/en/tft
+
+Dependecies
+-----------
+ncursesw shared library and headers (libncursesw5-dev on Debian/Ubuntu)
+
+Installation
+------------
+Make sure you satisfy the dependencies and execute:
+	git clone https://gitlab.com/venelin98/tft.git
+	cd tft
+	sudo ./install.sh
+
+Creating trees
+--------------
+Trees are created in plain text files following the tft file format.
+Spaces are not important but new lines are considered as separators.
+
+Adding a member
+---------------
+A new line begining with a name is considered a member definition, the name can include spaces.
+
+After the name the sex can be specifed with a comma followed by either M or F, if not given male is assumed.
+
+For example:
+	Adam, M
+	Declares member Adam that is male.
+
+Adding member information
+-------------------------
+In the lines following a member declaration, various info can be added:
+s: - Spouses, must be followed by comma separated names of already declared members, "-" can be given instead in which case the last declared person of the opposite sex is used
+p: - Parents, must be followed by 1 or 2 names separated by a comma, "-" can be given instead in which case the previous parents are used
+b: - Birthday in the format yyyy.mm.dd, day and month can be ommited
+d: - Death date
+
+Duplicate names
+---------------
+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
+
+Viewing trees
+-------------
+After creating a tree file you can view it using tft:
+	tft my_tree.tft
+
+Once the tree is displayed you can navigate it using:
+	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
+	w - close the current tree
+
+УПЪТВАНЕ НА БЪЛГАРСКИ:
+https://vene.volconst.com/bg/tft