Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lucas-flowers committed Sep 20, 2017
1 parent 2f8a578 commit 2fae137
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 8 deletions.
20 changes: 16 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<http://graphviz.org>`_:
Expand Down Expand Up @@ -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
<https://github.com/lucas-flowers/snutree/releases>`_. 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
---------------------

Expand Down
20 changes: 16 additions & 4 deletions docs/readme-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<http://graphviz.org>`_:
Expand Down Expand Up @@ -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
<https://github.com/lucas-flowers/snutree/releases>`_. 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
---------------------

Expand Down

0 comments on commit 2fae137

Please sign in to comment.