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

Add an example in the repo README.md file #314

Open
Ogeon opened this issue Apr 16, 2023 · 0 comments
Open

Add an example in the repo README.md file #314

Ogeon opened this issue Apr 16, 2023 · 0 comments
Labels
documentation Related to things like README or the API documentation.

Comments

@Ogeon
Copy link
Owner

Ogeon commented Apr 16, 2023

Description

There have been requests for some sort of code example for those who find the repo and would like to see how it looks and works. I think one or two examples can be added, together with the link to the inner readme. It should be automatically tested, just like the crate readme.

Motivation

Gives a quick preview of the library for those who don't want to dig into the sub-directories.
@Ogeon Ogeon added the documentation Related to things like README or the API documentation. label Apr 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Related to things like README or the API documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Ogeon