|
1 |
| -# embedded-fps |
| 1 | +# `embedded-fps` |
2 | 2 | [![sponsor-us]](https://github.com/sponsors/LechevSpace) [![crates-io]](https://crates.io/crates/embedded-fps) [![docs-rs]](https://docs.rs/embedded-fps)
|
3 |
| -## Frames Per Second counter for embedded devices. |
| 3 | + |
| 4 | +## Frames Per Second counter for embedded devices |
4 | 5 |
|
5 | 6 | Create an `FPS` struct by passing the `MAX_FPS` (maximum frames per seconds)
|
6 |
| -that you expect to hit and a [`embedded_time`][embedded-time-docs]`::Clock` implementation. |
| 7 | +that you expect to hit and a [`embedded_time`][embedded-time-docs] `Clock` implementation. |
7 | 8 |
|
8 | 9 | [embedded-time-docs]: https://docs.rs/embedded-time/
|
9 | 10 | [crates-io]: https://img.shields.io/crates/v/embedded-fps?logo=rust&style=for-the-badge
|
@@ -34,9 +35,20 @@ You can run this example from the `examples` directory using:
|
34 | 35 |
|
35 | 36 | ## Crate features
|
36 | 37 |
|
37 |
| -- `std` - enables [`StdClock`] - a [`Clock`] implementation using [`std`] for usage on a host machine. |
| 38 | +- `std` - enables `StdClock` - a `Clock` implementation using `std` for usage on a host machine. |
| 39 | + |
| 40 | +## License |
| 41 | + |
| 42 | +Licensed under either of [Apache License, Version 2.0](./LICENSE-APACHE) |
| 43 | +or [MIT license](./LICENSE-MIT) at your option. |
| 44 | + |
| 45 | +### Contribution |
| 46 | + |
| 47 | +Unless you explicitly state otherwise, any contribution intentionally submitted |
| 48 | +for inclusion in this project by you, as defined in the Apache-2.0 license, |
| 49 | +shall be dual licensed as above, without any additional terms or conditions. |
38 | 50 |
|
39 |
| -[`StdClock`]: crate::StdClock |
40 | 51 | [`embedded-graphics`]: https://crates.io/crates/embedded-graphics
|
41 | 52 | [`embedded-graphics-simulator`]: https://crates.io/crates/embedded-graphics-simulator
|
42 |
| -[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup |
| 53 | +[simulator-docs]: https://docs.rs/embedded-graphics-simulator/latest/embedded_graphics_simulator/#setup |
| 54 | +[`StdClock`]: crate::StdClock |
0 commit comments