Skip to content

Update README#363

Merged
jrebelo merged 4 commits into
mainfrom
update_docs
Feb 25, 2025
Merged

Update README#363
jrebelo merged 4 commits into
mainfrom
update_docs

Conversation

@jrebelo

@jrebelo jrebelo commented Feb 25, 2025

Copy link
Copy Markdown
Contributor

Update the README files for dds and ddsgen

@jrebelo jrebelo requested a review from stkimmer February 25, 2025 13:43
Comment thread dds_gen/README.md Outdated

This IDL gen is shipped as a library instead of a self standing tool since its main use case is to be integrated with a `build.rs` script. The entry function is `dust_dds_gen::compile_idl(&idl_path)` which generates a string with the output Rust code. Here is an example of an idl file:

```idl

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe example Build.rs instead since the idl is already further up

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the example to show how it is used in build.rs

@jrebelo jrebelo merged commit 482133b into main Feb 25, 2025
@jrebelo jrebelo deleted the update_docs branch February 25, 2025 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants