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

README.md #13

Merged
merged 1 commit into from
Feb 28, 2024
Merged

README.md #13

merged 1 commit into from
Feb 28, 2024

Conversation

strokyl
Copy link
Collaborator

@strokyl strokyl commented Feb 28, 2024

No description provided.

Copy link
Member

@qboileau qboileau left a comment

Choose a reason for hiding this comment

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

Could also add a small description on what this ctl is and used for
and on it's usage (needed env vars/print of help with all commands, ...)

@strokyl
Copy link
Collaborator Author

strokyl commented Feb 28, 2024

Could also add a small description on what this ctl is and used for and on it's usage (needed env vars/print of help with all commands, ...)

There is ctl help for that

@strokyl strokyl merged commit d414dfc into main Feb 28, 2024
3 checks passed
@qboileau
Copy link
Member

qboileau commented Feb 28, 2024

Could also add a small description on what this ctl is and used for and on it's usage (needed env vars/print of help with all commands, ...)

There is ctl help for that

Yes but when I'm reading a readme I don't want to have to build the binary to see what this all project is for ^^
A repo README is the first documentation of a project it should let us know what we are looking at and how to use it from a dev perspective (the build/test commands) but also from an end user point of view with a usage section.
And to simplify our documentation work yes we have the ctl help output to show here.

@qboileau qboileau deleted the add_readme branch March 25, 2024 14:04
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.

4 participants