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

Restructuring the documentation of CoCli #102

Closed
hannestschofenig opened this issue Dec 14, 2023 · 2 comments · Fixed by #99
Closed

Restructuring the documentation of CoCli #102

hannestschofenig opened this issue Dec 14, 2023 · 2 comments · Fixed by #99
Assignees

Comments

@hannestschofenig
Copy link
Collaborator

I am suggesting to make two changes to the documentation here:
https://github.com/veraison/corim/tree/main/cocli

  1. Provide a high-level description upfront. A simplified version of this figure will do it: https://github.com/veraison/corim/tree/main/cocli#visual-synopsis-of-the-available-commands
  2. In the command line examples use the data from the data directory. Currently, the command line examples use fictitious file names.

#99 goes into this direction

@yogeshbdeshpande
Copy link
Contributor

@hannestschofenig : To your point, I think the existing picture is a great summary that displays the overall capability of cocli tool!

Its just that it is far down below in the README.md

See a similar comment made by Ned Smith:
#89

yogeshbdeshpande added a commit that referenced this issue Dec 19, 2023
Fixes #102

Signed-off-by: Yogesh Deshpande <[email protected]>
@yogeshbdeshpande
Copy link
Contributor

@hannestschofenig Please check, if the #99
now reflects what you were looking for?

I have addressed 1. and 2. reported in your original issue description.

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 a pull request may close this issue.

2 participants