Skip to content

Commit dbb3195

Browse files
committed
Merge branch 'examples-readme' of git://github.com/pirtleshell/plotters
2 parents 378351a + 014997a commit dbb3195

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

examples/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# plotters examples
2+
3+
These are examples of plotters in use! Like in all Rust packages, examples can be built and run with `cargo`.
4+
5+
To run any example, from within the repo, run `cargo run --example <example_name>` where `<example name>` is the name of the file without the `.rs` extension.
6+
7+
The output of these example files are used to generate the [plotters-doc-data](https://github.com/38/plotters-doc-data) repo that populates the beautiful images you see in the main README. For that reason, they must be run with `cargo` from within the repo, or you must change the output filename in the example code to a directory that exists.
8+
9+
The examples that have their own directories and `Cargo.toml` files work differently. They are run the same way you would a standalone project.

0 commit comments

Comments
 (0)