Browse Source

readme: added setup instructions for mac & windows

Fabian Peter Hammerle 3 weeks ago
parent
commit
5d822263d6
1 changed files with 18 additions and 2 deletions
  1. 18 2
      README.md

+ 18 - 2
README.md

@@ -4,11 +4,27 @@ Define family trees in YAML
 
 ## Setup
 
+### Debian / Ubuntu
+
 ```sh
-$ sudo apt-get install python3-yaml python3-graphviz # optional on debian / ubuntu
-$ pip3 install --user --upgrade yamily[yaml,graphviz]
+$ sudo apt-get install python3-yaml python3-graphviz
+$ pip3 install --user --upgrade yamily
 ```
 
+### Mac
+
+```sh
+$ brew install graphviz
+$ pip3 install --upgrade yamily[yaml,graphviz]
+```
+
+### Windows
+
+1. [Download](https://graphviz.gitlab.io/_pages/Download/Download_windows.html) and install Graphviz.
+2. [Download](https://www.python.org/downloads/windows/) and install Python.
+3. Open Command Prompt / `cmd.exe`.
+4. Run command `pip install --user --upgrade yamily[yaml,graphviz]`.
+
 ## Usage
 
 ### Import YAML