From 97b4deaff1104a61dee0711599af8c1b734cdd88 Mon Sep 17 00:00:00 2001 From: Hayden Free Date: Fri, 11 Jan 2019 16:36:54 -0500 Subject: [PATCH] Update installation documentation --- docs/src/install.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/docs/src/install.md b/docs/src/install.md index 8b9119f0..e7314ad1 100644 --- a/docs/src/install.md +++ b/docs/src/install.md @@ -1,18 +1,11 @@ # Installation -To install the toolbox open the Julia REPL and run the following: - +Installation is straightforward. Enter Pkg mode in the Julia REPL by typing `]`, and then type: ```julia-repl -julia> using Pkg -julia> Pkg.add("CurricularAnalytics") +(v1.0) pkg> add CurricularAnalytics ``` -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. To install Blink.jl, first install the CurricularAnalytics.jl toolbox (as described above) and then execute the following commands from the Julia REPL: - -```julia-repl -julia> using Blink -julia> Blink.AtomShell.install() -``` +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. ## Troubleshooting