Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding how to use section #30

Merged
merged 1 commit into from
Mar 26, 2025
Merged

docs: adding how to use section #30

merged 1 commit into from
Mar 26, 2025

Conversation

gordonkoehn
Copy link

@gordonkoehn gordonkoehn commented Mar 12, 2025

This PR aims to enhance the README in how to use the utilities provided explicitly. Before, the ReadMe did not expressly state how to execute the scripts after installation.

This may be obvious to some, but it was not to me.
It may be helpful to add this here.


Minor:

  • Correcting format in Citation section

@gordonkoehn gordonkoehn self-assigned this Mar 12, 2025
@gordonkoehn
Copy link
Author

@LaraFuhrmann do you agree on this? Would this make it better ?

@gordonkoehn gordonkoehn requested a review from DrYak March 12, 2025 08:48
@gordonkoehn gordonkoehn marked this pull request as ready for review March 12, 2025 08:48
@gordonkoehn gordonkoehn linked an issue Mar 12, 2025 that may be closed by this pull request
@LaraFuhrmann
Copy link
Collaborator

Thank you Gordon! Looks good!

@gordonkoehn gordonkoehn requested a review from Copilot March 12, 2025 10:08
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

@gordonkoehn
Copy link
Author

Merging – reviewed and confirmed by @DrYak.

@gordonkoehn gordonkoehn merged commit f9a5132 into dev Mar 26, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add How to use in Readme
2 participants