From be13392c4f31c0a2324ec4183669a549a4aacca8 Mon Sep 17 00:00:00 2001 From: Dominique Date: Wed, 25 Oct 2023 08:55:38 -0400 Subject: [PATCH] list supported backends in docs --- docs/src/index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index a1fea9b..d26950f 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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: