Skip to content

Commit d0c1bea

Browse files
committed
Mention code generation from the main project README.
1 parent c767ac8 commit d0c1bea

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

ARCHITECTURE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,6 @@ getting methods to read and write component values.
8181

8282
## Code generation
8383

84-
See [codegen/README.md] for information on `glam`'s code generation process.
84+
See the [codegen README] for information on `glam`'s code generation process.
85+
86+
[codegen README]: codegen/README.md

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,4 @@ Also run `cargo fmt` and `cargo clippy` on any new code.
5555
[open an issue]: https://GitHub.com/bitshifter/glam-rs/issues/new
5656
[ask a question]: https://github.com/bitshifter/glam-rs/discussions/new?category=q-a
5757
[suggest a new feature]: https://github.com/bitshifter/glam-rs/discussions/new?category=ideas
58-
[ARCHITECTURE]: ARCHITECTURE.md
5958
[codegen README]: codegen/README.md

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -215,23 +215,26 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
215215
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
216216
dual licensed as above, without any additional terms or conditions.
217217

218+
If you are interested in contributing or have a request or suggestion
219+
[start a discussion] on GitHub. See [CONTRIBUTING.md] for more information for
220+
contributors.
221+
222+
Most code in `glam` is generated, see the [codegen README] for details.
223+
218224
Thank you to all of the `glam` [contributors]!
219225

220226
[Code of Conduct]: https://www.rust-lang.org/en-US/conduct.html
227+
[start a discussion]: https://github.com/bitshifter/glam-rs/discussions
228+
[CONTRIBUTING.md]: CONTRIBUTING.md
229+
[codegen README]: codegen/README.md
221230
[contributors]: https://github.com/bitshifter/glam-rs/graphs/contributors
222231

223232
## Support
224233

225-
If you are interested in contributing or have a request or suggestion
226-
[start a discussion] on GitHub. See [CONTRIBUTING.md] for more information for
227-
contributors.
228-
229234
The [Game Development in Rust Discord] and [Bevy Engine Discord] servers are
230235
not official support channels but can be good places to ask for help with
231236
`glam`.
232237

233-
[start a discussion]: https://github.com/bitshifter/glam-rs/discussions
234-
[CONTRIBUTING.md]: CONTRIBUTING.md
235238
[Game Development in Rust Discord]: https://discord.gg/yNtPTb2
236239
[Bevy Engine Discord]: https://discord.gg/gMUk5Ph
237240

0 commit comments

Comments
 (0)