Improve the README #157
Merged
Improve the README #157
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Improve the introduction * Update the supported Ubuntu version * Add a Quick Start section including several examples * Add a link to the documentation website Signed-off-by: Leandro Lucarella <[email protected]>
|
This is not ideal in the sense that there is probably quite a bit of duplication between the readme and the docs in the docstrings. In the future we might want to make the README much smaller and just redirect the user to the right documentation website sections. But it was quicker to do this with the help of AI than to carefully review the whole docs to see how to make a proper README with less duplication. |
Marenz
approved these changes
Jun 23, 2025
cwasicki
approved these changes
Jun 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #156.