Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for running with cairo #97

Merged
merged 2 commits into from
Nov 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,12 @@ members = [
"piet-web",
"piet-web/examples/basic"
]

default-members = [
"piet",
"piet-cairo",
"piet-common",
"piet-test",
"piet-web",
"piet-web/examples/basic"
]
Copy link
Member

@cmyr cmyr Nov 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the significance of this change?

edit: oh, maybe #33 (comment)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's where it came from.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it also makes sense to remove piet-cairo from this list and have users explicitly choose a backend with --features.

10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ This repo is structured as a core API crate, "piet" and a separate crate for eac

A companion for Bézier path representation and geometry is [kurbo].

The piet-cairo crate depends on the cairo library, found at
https://www.cairographics.org/download/. A simple test of the cairo
backend is to run `cargo run --example basic-cairo`, which should
produce an image file called "temp-cairo.png".

The piet-direct2d create works on Windows only. Build with `cargo
build --all` to include it. A simple test of the direct2d backend is
to run `cargo run --example basic`, which should produce an image
called "temp-image.png".

## Roadmap

Since the project is in its infant stages, there's not currently a set roadmap. For a good idea of what the library will eventually be capable of see [this list][resvg backend requirements] of requirements to be a backend 2D graphics library for the SVG rendering library resvg.
Expand Down