Browse Source

readme: added plot cmd

Fabian Peter Hammerle 7 months ago
parent
commit
23470060ac
1 changed files with 9 additions and 2 deletions
  1. 9 2
      README.md

+ 9 - 2
README.md

@@ -22,7 +22,7 @@ $ pip3 install --user --upgrade yamily[yaml,graphviz]
 ... birth_date: 2019-12-23
 ... mother: !person
 ...   identifier: alice-mother
-...   name: Carol Test 
+...   name: Carol Test
 ...   birth_date: 1992-10-26
 ... father: !person
 ...   identifier: bob
@@ -49,7 +49,7 @@ Person(alice-mother, Carol Test, *1992-10-26)
 >>> carol_yaml = '''
 ... !person
 ... identifier: carol
-... name: Carol Test 
+... name: Carol Test
 ... birth_date: 1992-10-26
 ... '''
 >>> collection = yamily.PersonCollection()
@@ -90,6 +90,13 @@ name: Alice Test
 
 ```
 
+### Plot Family Tree
+
+```sh
+$ yamily-dot . > tree.dot
+$ dot -Tpdf -O tree.dot
+```
+
 ## Develop
 
 ```sh