From 9f02020c6fa47f2ece73079ec99d8f34a12c02a7 Mon Sep 17 00:00:00 2001
From: Ted Ralphs <tkralphs@gmail.com>
Date: Thu, 19 Jan 2017 19:02:52 +0100
Subject: [PATCH] Update README.md

---
 README.md | 42 ++++++++++++++++++++++++++++++++++--------
 1 file changed, 34 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 9e285ce..9c396f7 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-GiMPy 1.3
-=========
+#GiMPy 1.3
+
+[![DOI](https://zenodo.org/badge/18214894.svg)](https://zenodo.org/badge/latestdoi/18214894)
 
 Graph Methods in Python (GiMPy) is a Python graph library containing pure
 Python implementations of a variety of graph algorithms. The goal is clarity
@@ -10,22 +11,36 @@ Documentation for the API is here:
 
 https://coin-or.github.io/GiMPy
 
-Installation:
+Pypi download page is here:
+
+https://pypi.python.org/pypi/coinor.gimpy
+
+## Installation Notes
+
+To install, do
 
-`easy_install coinor.gimpy`
+```
+easy_install coinor.gimpy
+```
+or
+```
+pip install coinor.gimpy
+```
 
 ##Installation Notes
 
-In order for GiMPy to visualize the graphs it produces, it's necessary to 
-install [GraphViz](http://www.graphviz.org/Download.php) and choose one of 
-these additional methods for display:
+In order for GiMPy to visualize the graphs it produces, it's necessary to install 
+  [GraphViz](http://www.graphviz.org/Download.php) (**Important**: after installing
+  graphviz, you must add the graphviz `bin` directory, usually 
+  `C:\Program Files (x86)\Graphviz2.38\bin`, to your `PATH`) 
+  and choose one of these additional methods for display:
   * Recommended: [xdot](https://pypi.python.org/pypi/xdot) along with 
     [PyGtk](http://www.pygtk.org/) and call `set_display_mode('xdot')`
   * [Python Imaging Library](http://www.pythonware.com/products/pil/) and 
     call `set_display_mode('PIL')`
   * [Pygame](pygame.org) and call `set_display_mode('pygame')`
   * Call `set_display_mode('file')` to just write files to disk that have to
-    then be opened manually.
+    then be opened manually. 
 
 It is also possible to typeset labels in LaTex and to output the graph in 
 LaTex format using `dot2tex`. After installing `dot2tex`, this can be done 
@@ -36,6 +51,17 @@ the latter only seems to work with version `2.9.0dev` available
 [here](https://github.com/Alwnikrotikz/dot2tex). For the former method, just 
 using `easy_install dot2tex` should work fine.
 
+# Additional Notes for Windows Users
+
+On Windows, if you want to use `xdot`, there are some additional particulars.
+  * You must install the 32-bit version of Python 2.7
+  * You must install the [PyGtk version 2.22.6](http://ftp.gnome.org/pub/GNOME/binaries/win32/pygtk/2.22/pygtk-all-in-one-2.22.6.win32-py2.7.msi). Version 2.24 is buggy on Windows.
+  * You must install version 0.6 of xdot with e.g., `pip install xdot==0.6` 
+  
+# Additional Notes for Linux and OS X Users
+
+There have been reports of incompatibilities with recent versions of PyGtk, but I have not attempted yet to track this down. If things break, you may try some variant of the instructions above for installing on Windows.
+
 ##Examples
 
 ###Forestry Model