Skip to content

Commit afe13a9

Browse files
jonathanpallantVeykril
authored andcommitted
Add missing README
1 parent f6f4741 commit afe13a9

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

defmt-03/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# `defmt`
2+
3+
`defmt` ("de format", short for "deferred formatting") is a highly efficient logging framework that targets resource-constrained devices, like microcontrollers.
4+
5+
For more details about the framework check the book at <https://defmt.ferrous-systems.com>.
6+
7+
This release is a semver-trick compatibility shim that allows packages using `defmt = "0.3"` to inter-operate with packages using `defmt = "1.0"`.
8+
9+
## Setup
10+
11+
### New project
12+
13+
The fastest way to get started with `defmt` is to use our [app-template] to set up a new Cortex-M embedded project.
14+
15+
[app-template]: https://github.com/knurling-rs/app-template
16+
17+
### Existing project
18+
19+
To include `defmt` in your existing project, follow our [Application Setup guide].
20+
21+
[Application Setup guide]: https://defmt.ferrous-systems.com/setup.html
22+
23+
## MSRV
24+
25+
The minimum supported Rust version is 1.76 (or Ferrocene 24.05). `defmt` is tested against the latest stable Rust version and the MSRV.
26+
27+
## Support
28+
29+
`defmt` is part of the [Knurling] project, [Ferrous Systems]' effort at
30+
improving tooling used to develop for embedded systems.
31+
32+
If you think that our work is useful, consider sponsoring it via [GitHub
33+
Sponsors].
34+
35+
## License
36+
37+
Licensed under either of
38+
39+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
40+
http://www.apache.org/licenses/LICENSE-2.0)
41+
42+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
43+
44+
at your option.
45+
46+
### Contribution
47+
48+
Unless you explicitly state otherwise, any contribution intentionally submitted
49+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
50+
licensed as above, without any additional terms or conditions.
51+
52+
[Knurling]: https://knurling.ferrous-systems.com/
53+
[Ferrous Systems]: https://ferrous-systems.com/
54+
[GitHub Sponsors]: https://github.com/sponsors/knurling-rs

0 commit comments

Comments
 (0)