Skip to content

Commit

Permalink
Update installation notes
Browse files Browse the repository at this point in the history
Users are now required to install the specific backend they would like
  • Loading branch information
ConnectedSystems authored and mchitre committed Nov 27, 2023
1 parent c0fbc5f commit ff9dfc0
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,22 @@ This package does not aim to provide comprehensive production quality plotting.

### Installation

Install InteractiveViz.jl with one of the Makie backends that support interactivity (GLMakie or WebGLMakie).

```julia
julia>]
pkg> add InteractiveViz
pkg> add InteractiveViz GLMakie
```

If more than one Makie backend is available, switch between them in the usual way.

```julia
using GLMakie

GLMakie.activate!()

using WGLMakie
WGLMakie.activate!()
```

### Quick start
Expand All @@ -31,7 +44,7 @@ pkg> add InteractiveViz

Let's start off visualizing a simple function of one variable:
```julia
julia> using InteractiveViz
julia> using InteractiveViz, GLMakie
julia> ilines(sin, 0, 100)
```

Expand Down

0 comments on commit ff9dfc0

Please sign in to comment.