Skip to content

Commit 0424302

Browse files
jonathanpallantjonathanpallant
authored
Merge pull request #897 from knurling-rs/fix-readmes
Fix the READMEs.
2 parents dfee451 + 2984bf0 commit 0424302

File tree

11 files changed

+231
-8
lines changed

11 files changed

+231
-8
lines changed

‎CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,7 @@ Initial release
580580
> Parsing library for defmt format strings
581581
582582
[defmt-parser-next]: https://github.com/knurling-rs/defmt/compare/defmt-parser-v0.4.0...main
583+
[defmt-parser-v0.4.1]: https://github.com/knurling-rs/defmt/releases/tag/defmt-parser-v0.4.1
583584
[defmt-parser-v0.4.0]: https://github.com/knurling-rs/defmt/releases/tag/defmt-parser-v0.4.0
584585
[defmt-parser-v0.3.4]: https://github.com/knurling-rs/defmt/releases/tag/defmt-parser-v0.3.4
585586
[defmt-parser-v0.3.3]: https://github.com/knurling-rs/defmt/releases/tag/defmt-parser-v0.3.3
@@ -593,6 +594,10 @@ Initial release
593594

594595
### [defmt-parser-next]
595596

597+
### [defmt-parser-v0.4.1] (2024-11-27)
598+
599+
* [#897] Added its own README
600+
596601
### [defmt-parser-v0.4.0] (2024-11-27)
597602

598603
### [defmt-parser-v0.3.4] (2024-03-05)
@@ -812,6 +817,7 @@ Initial release
812817

813818
---
814819

820+
[#897]: https://github.com/knurling-rs/defmt/pull/897
815821
[#889]: https://github.com/knurling-rs/defmt/pull/889
816822
[#887]: https://github.com/knurling-rs/defmt/pull/887
817823
[#884]: https://github.com/knurling-rs/defmt/pull/884

‎decoder/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ edition = "2021"
55
keywords = ["knurling", "defmt"]
66
license = "MIT OR Apache-2.0"
77
name = "defmt-decoder"
8-
readme = "../README.md"
8+
readme = "README.md"
99
repository = "https://github.com/knurling-rs/defmt"
1010
version = "0.4.0"
1111

1212
[dependencies]
1313
byteorder = "1"
1414
colored = "2"
15-
defmt-parser = { version = "=0.4.0", path = "../parser" }
15+
defmt-parser = { version = "=0.4.1", path = "../parser" }
1616
ryu = "1"
1717
nom = "7"
1818

‎decoder/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# `defmt-decoder`
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+
The git version of the defmt book can be viewed at <https://defmt-next.ferrous-systems.com/>.
8+
9+
This library is for decoding [`defmt`](https://crates.io/crates/defmt) frames
10+
into formatted strings. It is used by
11+
[`defmt-print`](https://crates.io/crates/defmt-print) and other tools.
12+
13+
## MSRV
14+
15+
The minimum supported Rust version is 1.76 (or Ferrocene 24.05). `defmt` is tested against the latest stable Rust version and the MSRV.
16+
17+
## Support
18+
19+
`defmt` is part of the [Knurling] project, [Ferrous Systems]' effort at
20+
improving tooling used to develop for embedded systems.
21+
22+
If you think that our work is useful, consider sponsoring it via [GitHub
23+
Sponsors].
24+
25+
## License
26+
27+
Licensed under either of
28+
29+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
30+
http://www.apache.org/licenses/LICENSE-2.0)
31+
32+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
33+
34+
at your option.
35+
36+
### Contribution
37+
38+
Unless you explicitly state otherwise, any contribution intentionally submitted
39+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
40+
licensed as above, without any additional terms or conditions.
41+
42+
[Knurling]: https://knurling.ferrous-systems.com/
43+
[Ferrous Systems]: https://ferrous-systems.com/
44+
[GitHub Sponsors]: https://github.com/sponsors/knurling-rs

‎decoder/defmt-json-schema/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ edition = "2021"
55
keywords = ["knurling", "defmt"]
66
license = "MIT OR Apache-2.0"
77
name = "defmt-json-schema"
8-
readme = "../../README.md"
8+
readme = "README.md"
99
repository = "https://github.com/knurling-rs/defmt"
1010
version = "0.1.0"
1111

‎decoder/defmt-json-schema/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# `defmt-json-schema`
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+
The git version of the defmt book can be viewed at <https://defmt-next.ferrous-systems.com/>.
8+
9+
This library describes the JSON output from
10+
[`defmt-decoder`](https://crates.io/crates/defmt-decoder).
11+
12+
## MSRV
13+
14+
The minimum supported Rust version is 1.76 (or Ferrocene 24.05). `defmt` is tested against the latest stable Rust version and the MSRV.
15+
16+
## Support
17+
18+
`defmt` is part of the [Knurling] project, [Ferrous Systems]' effort at
19+
improving tooling used to develop for embedded systems.
20+
21+
If you think that our work is useful, consider sponsoring it via [GitHub
22+
Sponsors].
23+
24+
## License
25+
26+
Licensed under either of
27+
28+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
29+
http://www.apache.org/licenses/LICENSE-2.0)
30+
31+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
32+
33+
at your option.
34+
35+
### Contribution
36+
37+
Unless you explicitly state otherwise, any contribution intentionally submitted
38+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
39+
licensed as above, without any additional terms or conditions.
40+
41+
[Knurling]: https://knurling.ferrous-systems.com/
42+
[Ferrous Systems]: https://ferrous-systems.com/
43+
[GitHub Sponsors]: https://github.com/sponsors/knurling-rs

‎firmware/defmt-test/macros/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ edition = "2021"
55
keywords = ["knurling", "defmt", "testing"]
66
license = "MIT OR Apache-2.0"
77
name = "defmt-test-macros"
8-
readme = "../README.md"
8+
readme = "README.md"
99
repository = "https://github.com/knurling-rs/defmt"
1010
version = "0.3.1"
1111

‎firmware/defmt-test/macros/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# `defmt-test-macros`
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+
The git version of the defmt book can be viewed at <https://defmt-next.ferrous-systems.com/>.
8+
9+
This library contains the proc macros used by
10+
[`defmt-test`](https://crates.io/crates/defmt-test).
11+
12+
## MSRV
13+
14+
The minimum supported Rust version is 1.76 (or Ferrocene 24.05). `defmt` is tested against the latest stable Rust version and the MSRV.
15+
16+
## Support
17+
18+
`defmt` is part of the [Knurling] project, [Ferrous Systems]' effort at
19+
improving tooling used to develop for embedded systems.
20+
21+
If you think that our work is useful, consider sponsoring it via [GitHub
22+
Sponsors].
23+
24+
## License
25+
26+
Licensed under either of
27+
28+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
29+
http://www.apache.org/licenses/LICENSE-2.0)
30+
31+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
32+
33+
at your option.
34+
35+
### Contribution
36+
37+
Unless you explicitly state otherwise, any contribution intentionally submitted
38+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
39+
licensed as above, without any additional terms or conditions.
40+
41+
[Knurling]: https://knurling.ferrous-systems.com/
42+
[Ferrous Systems]: https://ferrous-systems.com/
43+
[GitHub Sponsors]: https://github.com/sponsors/knurling-rs

‎macros/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ edition = "2021"
55
keywords = ["knurling", "defmt"]
66
license = "MIT OR Apache-2.0"
77
name = "defmt-macros"
8-
readme = "../README.md"
8+
readme = "README.md"
99
repository = "https://github.com/knurling-rs/defmt"
1010
version = "0.3.10"
1111

@@ -17,7 +17,7 @@ proc-macro = true
1717
unstable-test = []
1818

1919
[dependencies]
20-
defmt-parser = { version = "=0.4.0", path = "../parser" }
20+
defmt-parser = { version = "=0.4.1", path = "../parser" }
2121
proc-macro-error2 = "2"
2222
proc-macro2 = "1"
2323
quote = "1"

‎macros/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# `defmt-macros`
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+
The git version of the defmt book can be viewed at <https://defmt-next.ferrous-systems.com/>.
8+
9+
This library contains the proc macros used by
10+
[`defmt`](https://crates.io/crates/defmt).
11+
12+
## MSRV
13+
14+
The minimum supported Rust version is 1.76 (or Ferrocene 24.05). `defmt` is tested against the latest stable Rust version and the MSRV.
15+
16+
## Support
17+
18+
`defmt` is part of the [Knurling] project, [Ferrous Systems]' effort at
19+
improving tooling used to develop for embedded systems.
20+
21+
If you think that our work is useful, consider sponsoring it via [GitHub
22+
Sponsors].
23+
24+
## License
25+
26+
Licensed under either of
27+
28+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
29+
http://www.apache.org/licenses/LICENSE-2.0)
30+
31+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
32+
33+
at your option.
34+
35+
### Contribution
36+
37+
Unless you explicitly state otherwise, any contribution intentionally submitted
38+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
39+
licensed as above, without any additional terms or conditions.
40+
41+
[Knurling]: https://knurling.ferrous-systems.com/
42+
[Ferrous Systems]: https://ferrous-systems.com/
43+
[GitHub Sponsors]: https://github.com/sponsors/knurling-rs

‎parser/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ edition = "2021"
55
keywords = ["knurling", "defmt"]
66
license = "MIT OR Apache-2.0"
77
name = "defmt-parser"
8-
readme = "../README.md"
8+
readme = "README.md"
99
repository = "https://github.com/knurling-rs/defmt"
10-
version = "0.4.0"
10+
version = "0.4.1"
1111

1212
[dependencies]
1313
thiserror = "2"

0 commit comments

Comments
 (0)