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

Improve examples #1

Open
2 tasks
andgdk opened this issue Jan 1, 2025 · 0 comments
Open
2 tasks

Improve examples #1

andgdk opened this issue Jan 1, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@andgdk
Copy link
Owner

andgdk commented Jan 1, 2025

Description

Currently, there are only a few parameters or settings to showcase. The only existing example is given in by the index.sce file.

Consider creating a Jupyter notebook using the Scilab kernel to provide examples.

Proposed solution

  • Draft a notebook that demonstrates the usage of the project with various examples.
  • Add examples to the main readme file.

Alternatives considered

Only add an example to the main readme file.

@andgdk andgdk added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant