-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Align the style of the README with Vello (#19)
Also removes clippy.toml - see rust-lang/rust-clippy#11735 Also add a name to the CI workflow
- Loading branch information
Showing
3 changed files
with
45 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
name: CI | ||
on: | ||
push: | ||
branches: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,52 @@ | ||
# peniko, a Rust 2D graphics type library | ||
The peniko library builds on top of [kurbo] and provides a set of generic types that define | ||
styles for rendering and composition. | ||
<div align="center"> | ||
|
||
The name "peniko" is Esperanto for "brush" which is one family of types that the library | ||
# Peniko | ||
|
||
**A Rust 2D graphics type library** | ||
|
||
[![Linebender Zulip, #kurbo stream](https://img.shields.io/badge/Linebender-%23kurbo-red?logo=Zulip)](https://xi.zulipchat.com/#narrow/stream/260979-kurbo) | ||
[![dependency status](https://deps.rs/repo/github/linebender/peniko/status.svg)](https://deps.rs/repo/github/linebender/peniko) | ||
[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](#license) | ||
[![kurbo version 0.10](https://img.shields.io/badge/kurbo-v0.10-orange.svg)](https://crates.io/crates/wgpu) | ||
<!-- [![Crates.io](https://img.shields.io/crates/v/peniko.svg)](https://crates.io/crates/peniko) --> | ||
<!-- [![Docs](https://docs.rs/peniko/badge.svg)](https://docs.rs/peniko) --> | ||
<!-- [![Build status](https://github.com/linebender/peniko/workflows/CI/badge.svg)](https://github.com/linebender/peniko/actions) --> | ||
|
||
</div> | ||
|
||
The Peniko library builds on top of [kurbo] and provides a set of generic types that define | ||
styles for rendering and composition. | ||
|
||
The name "Peniko" is Esperanto for "brush" which is one family of types that the library | ||
contains. | ||
|
||
This library is in early development stages and will initially contain the relevant types | ||
from [piet-scene] but the intent is to be a generally useful set of primitives for vector | ||
graphics and text. | ||
## Community | ||
|
||
[![Linebender Zulip, #kurbo stream](https://img.shields.io/badge/Linebender-%23kurbo-red?logo=Zulip)](https://xi.zulipchat.com/#narrow/stream/260979-kurbo) | ||
|
||
Discussion of Peniko development happens in the Linebender Zulip at <https://xi.zulipchat.com/>, specifically the [#kurbo stream](https://xi.zulipchat.com/#narrow/stream/260979-kurbo). | ||
All public content can be read without logging in | ||
|
||
## License | ||
|
||
Licensed under either of | ||
|
||
- Apache License, Version 2.0 | ||
([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>) | ||
- MIT license | ||
([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>) | ||
|
||
at your option. | ||
|
||
## Contribution | ||
|
||
Contributions are welcome by pull request. The [Rust code of conduct] applies. | ||
Please feel free to add your name to the [AUTHORS] file in any substantive pull request. | ||
|
||
## Contributing | ||
Contributions are welcome. The [Rust Code of Conduct] applies. Please feel free to add your | ||
name to the [AUTHORS] file in any substantive pull request. | ||
Unless you explicitly state otherwise, any contribution intentionally submitted | ||
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be | ||
licensed as above, without any additional terms or conditions. | ||
|
||
[kurbo]: https://crates.io/crates/kurbo | ||
[piet-scene]: https://github.com/linebender/piet-gpu/tree/main/piet-scene | ||
[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct | ||
[AUTHORS]: ./AUTHORS |
This file was deleted.
Oops, something went wrong.