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

Consider creating a "Usage" section in the README #346

Open
Shnatsel opened this issue Jul 20, 2022 · 1 comment
Open

Consider creating a "Usage" section in the README #346

Shnatsel opened this issue Jul 20, 2022 · 1 comment
Labels
acknowledged enhancement help wanted

Comments

@Shnatsel
Copy link

Once I have found the repository, I had some trouble figuring out what are the names of the generated crates actually are. I have browsed the source code, but could not easily find them.

Only the next day I found this in the README:

To find a library of your interest, you might want to proceed looking at the API documentation index.

Once I found that link, everything was pretty straightforward.

Perhaps it should be featured more prominently, under a "Usage" heading in the readme.md or some such?
@Byron
Copy link
Owner

Byron commented Jul 20, 2022

I totally agree! It should be straightforward to adjust one of the templates to make such improvement and a contribution is very welcome.

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

No branches or pull requests
2 participants
@Byron @Shnatsel