Skip to content

Commit f26ffeb

Browse files
authored
Clarify Quick Start procedure so program works on first try
Previously the quadratic function chart Quick Start instructions did not tell the user to create the subdir plotters-doc-data, where the example code writes 0.png. When the subdir plotters-doc-data does not exist, the code appropriately panics. This does not leave the user with a good first impression of the repository & rust crate. Now the instructions clearly tell the user to create the subdirectory before running the example program.
1 parent 1782858 commit f26ffeb

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,9 @@ To use Plotters, you can simply add Plotters into your `Cargo.toml`
165165
[dependencies]
166166
plotters = "0.3.3"
167167
```
168+
Create the subdirectory `<Cargo project dir>/plotters-doc-data`
168169

169-
And the following code draws a quadratic function. `src/main.rs`,
170+
And the following code draws a quadratic function. `src/main.rs` writes the chart to `plotters-doc-data/0.png`
170171

171172
```rust
172173
use plotters::prelude::*;

0 commit comments

Comments
 (0)