Skip to content

Commit fcd7f79

Browse files
committed
README: add notes on uniplot limitations
1 parent c5c95e6 commit fcd7f79

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,15 @@ PlotRNA.plot_structure_makie("(((...)))")
6363

6464
### Terminal plotting with UnicodePlots
6565

66-
Plotting in the terminal is supported via UnicodePlots.
66+
Plotting in the terminal is supported via UnicodePlots with
67+
coordinates generated by ViennaRNA.
68+
69+
Note: this is still considered experimental. There are still some
70+
problems with plot sizes and aspect ratios. Additionally, when calling
71+
`uniplot` with an illegal structure or unbalanced parentheses it is
72+
possible to produce a segfault (coming from `plot_coords` in ViennaRNA
73+
that is used to generate coordinates for plotting). See:
74+
[https://github.com/marcom/ViennaRNA.jl/issues/13](https://github.com/marcom/ViennaRNA.jl/issues/13).
6775

6876
```julia
6977
using UnicodePlots, PlotRNA

0 commit comments

Comments
 (0)