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

Documentation #20

Closed
pradal opened this issue Apr 7, 2022 · 1 comment
Closed

Documentation #20

pradal opened this issue Apr 7, 2022 · 1 comment
Assignees
Labels

Comments

@pradal
Copy link
Collaborator

pradal commented Apr 7, 2022

Update the README:

  • install instruction
  • short and long description
  • main functionalities with
  • rational /theory
  • use case
  • example with code

Add also a documented tutorial with a notebook

@pradal
Copy link
Collaborator Author

pradal commented Jan 20, 2025

Close by #22

@pradal pradal closed this as completed Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants