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.

Sign up for GitHub

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

Jump to bottom

Improve README #15

Open
iainlane opened this issue Jul 22, 2022 · 1 comment
Open

Improve README #15

iainlane opened this issue Jul 22, 2022 · 1 comment

Comments

@iainlane
Copy link
Contributor

iainlane commented Jul 22, 2022 •
edited
Loading

I came across chisel today. It looks like an exciting tool, but unfortunately the README doesn't make it very clear what its purpose is.

Could you please expand the README? Some suggestions:

  • Start with an overview of what the tool is
  • Give some examples of usage with explanations of what the commands do
  • Define any new terms you've invented (e.g. I see mention of slice but it's not very clear what that term means here)
  • Compare to similar projects in the space, noting when you might use the other project or when you might use chisel
@d-mankowski-synerise
Copy link

I found some (at least a bit) helpful stuff here: https://www.youtube.com/watch?v=RMqjQ_i9eP0&t=1314s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@iainlane @d-mankowski-synerise