Skip to content

Commit

Permalink
list supported backends in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dpo committed Oct 25, 2023
1 parent ccf20e9 commit be13392
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ julia> performance_profile(PlotsBackend(), T, ["Solver 1", "Solver 2", "Solver 3

![Performance Profile](assets/random_profile.png)

## Supported Backends

Currently supported backends are:

* [Plots.jl](https://github.com/JuliaPlots/Plots.jl);
* [UnicodePlots.jl](https://github.com/JuliaPlots/UnicodePlots.jl);
* [PGFPlotsX.jl](https://github.com/KristofferC/PGFPlotsX.jl).

Backends are treated as optional dependencies, but one is required to produce a plot.
The user should import one of the supported backends before calling one of the plotting functions.

## Adding a New Backend

In order to add a new backend, there are two steps:
Expand Down

0 comments on commit be13392

Please sign in to comment.