Improve README: Add detailed command-line tools mapping and usage instructions #324
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
jakebeal
approved these changes
Jun 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request updates the README.md to provide a clearer overview of the SBOL-utilities package, including:
A detailed table mapping each command-line tool to its corresponding Python module and entry point function, helping developers quickly locate and understand utility implementations.
Usage instructions for key utilities, including code examples for both command-line and Python import contexts.
Updated installation notes highlighting dependencies for specific utilities.
Badges for documentation, testing, and PyPI status to enhance the project’s presentation.
These improvements aim to make it easier for new users and contributors to navigate and use the utilities effectively.