From 2fae1370025cce66f0b3bb8da0bb4ce1f826ede9 Mon Sep 17 00:00:00 2001 From: Lucas Flowers <31171608+lucas-flowers@users.noreply.github.com> Date: Wed, 20 Sep 2017 17:48:59 -0400 Subject: [PATCH] Update installation instructions --- README.rst | 20 ++++++++++++++++---- docs/readme-template.rst | 20 ++++++++++++++++---- 2 files changed, 32 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index b8b6378..aee6abd 100644 --- a/README.rst +++ b/README.rst @@ -159,11 +159,13 @@ features. Installation ============ -Linux ------ +With PIP +-------- -These instructions are based on Ubuntu and Debian-based installations. You may -need to modify them for your own system. +These instructions are based on Ubuntu and Debian-based installations, but they +can be made to apply to any Unix-like system (including macOS) with what should +be minor modifications. (These instructions are also applicable to Windows, +though after less minor modifications.) First, install Python (>=3.5), Python's ``pip`` package manager, and `Graphviz `_: @@ -194,6 +196,16 @@ directory. Make sure that ``~/.local/bin`` is in your PATH. You might run ``pip`` without the ``--user`` flag to install it system-wide, but this will require root. +Windows +------- + +Since installation on Windows is less straightforward, Windows executables have +been compiled and are available `here +`_. After downloading the +executable, you must install Graphviz and add ``C:\Program Files +(x86)\GraphvizX.XX\bin`` (or equivalent) to your Windows PATH. You can now run +the command-line or GUI executables. + Optional Dependencies --------------------- diff --git a/docs/readme-template.rst b/docs/readme-template.rst index 7dabbbb..e49357b 100644 --- a/docs/readme-template.rst +++ b/docs/readme-template.rst @@ -112,11 +112,13 @@ features. Installation ============ -Linux ------ +With PIP +-------- -These instructions are based on Ubuntu and Debian-based installations. You may -need to modify them for your own system. +These instructions are based on Ubuntu and Debian-based installations, but they +can be made to apply to any Unix-like system (including macOS) with what should +be minor modifications. (These instructions are also applicable to Windows, +though after less minor modifications.) First, install Python (>=3.5), Python's ``pip`` package manager, and `Graphviz `_: @@ -147,6 +149,16 @@ directory. Make sure that ``~/.local/bin`` is in your PATH. You might run ``pip`` without the ``--user`` flag to install it system-wide, but this will require root. +Windows +------- + +Since installation on Windows is less straightforward, Windows executables have +been compiled and are available `here +`_. After downloading the +executable, you must install Graphviz and add ``C:\Program Files +(x86)\GraphvizX.XX\bin`` (or equivalent) to your Windows PATH. You can now run +the command-line or GUI executables. + Optional Dependencies ---------------------