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

Update README and provide examples #28

Open
dpalmasan opened this issue Jan 22, 2023 · 0 comments
Open

Update README and provide examples #28

dpalmasan opened this issue Jan 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dpalmasan
Copy link
Owner

Repo currently lacks of README so it is kind of tricky to understand what it is about, and how to run the examples as well. This issue is to track progress on README updates, some content that I am aware needs to be added:

  • How to install repo locally
  • How to run the examples
@dpalmasan dpalmasan added the documentation Improvements or additions to documentation label Jan 22, 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 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dpalmasan