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

Include more documentation in the readme #6

Merged
merged 18 commits into from
Aug 9, 2024
Merged

Conversation

vbfox
Copy link
Collaborator

@vbfox vbfox commented Aug 8, 2024

Include more documentation in the readme and in the doc-comments.

  • Document most of our custom commands, both in the code and in the readme. Including examples.
  • Include full installation instructions, including how to use it from scratch
  • Explain in the readme the different usage patterns (Interactive, CI) and how to use them with this library.

@vbfox vbfox force-pushed the vbfox/more-docs-in-readme branch from 74172b4 to afde992 Compare August 8, 2024 16:00
@vbfox vbfox marked this pull request as ready for review August 9, 2024 09:42
@vbfox vbfox merged commit 1d8c65a into main Aug 9, 2024
6 checks passed
@vbfox vbfox deleted the vbfox/more-docs-in-readme branch August 9, 2024 09:44
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.

1 participant