Skip to content

Commit

Permalink
Add Windows installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenfree committed Jan 11, 2019
1 parent 97b4dea commit c673826
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit c673826

Please sign in to comment.