From c6738265136cc0cb98ce5c608da9c232dd91d89b Mon Sep 17 00:00:00 2001 From: Hayden Free Date: Fri, 11 Jan 2019 16:59:55 -0500 Subject: [PATCH] Add Windows installation instructions --- docs/src/install.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/src/install.md b/docs/src/install.md index e7314ad1..77794902 100644 --- a/docs/src/install.md +++ b/docs/src/install.md @@ -7,6 +7,11 @@ Installation is straightforward. Enter Pkg mode in the Julia REPL by typing `]` The CurricularAnalytics.jl toolbox contains sophisticated visualization capabilities. In order to use them, you must first install the [Blink.jl](http://junolab.org/Blink.jl/latest/) package. Blink.jl is a Julia wrapper that leverages the [Electron](https://electronjs.org) framework to perform the actual visualizations. Blink.jl should install automatically when you install the CurricularAnalytics.jl toolbox, and Electron will also install automatically upon first use of the visualization functions. +## Windows Specific Steps +If you are using Windows you must add the location of Julia to your PATH environment variable. To do this go to Control Panel -> System -> Advanced System Settings -> Environment Variables -> Path and click edit. Here you must append the file path of the Julia \bin directory. + +If you are using Julia version 1.0.1 with default settings the path would be `C:\Users\[YOUR USERNAME]\AppData\Local\Julia-1.0.1\bin` + ## Troubleshooting Following these steps should allow you to install and use the toolbox; however, in the event you experience an error of some type, please submit an issue by clicking [this link](https://github.com/heileman/CurricularAnalytics.jl/issues/new) and following these steps: