Readme improvments

[jeandet]

The idea is to have a more appealing README for the next release.

[codecov]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (0cf40a0) 87.27% compared to head (3af68e5) 87.28%.

❗ Current head 3af68e5 differs from pull request most recent head 0e44ce9. Consider uploading reports for the commit 0e44ce9 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #104   +/-   ##
=======================================
  Coverage   87.27%   87.28%           
=======================================
  Files          51       51           
  Lines        3050     3052    +2     
  Branches      495      495           
=======================================
+ Hits         2662     2664    +2     
  Misses        251      251           
  Partials      137      137           

Flag	Coverage Δ
unittests	86.63% <87.50%> (-0.62%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
speasy/plotting/mpl_backend/__init__.py	84.09% <87.50%> (+0.75%)	⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jeandet]

@cmoissar, @vgenot do you have any notebooks we could add to the Speasy gallery :) ?
That would be nice to add some more realistic use-cases here https://speasy.readthedocs.io/en/latest/examples/index.html.

[cmoissar]

Working on it!

…

On Fri, 27 Oct 2023 at 09:57, Alexis Jeandet ***@***.***> wrote: @cmoissar <https://github.com/cmoissar>, @vgenot <https://github.com/vgenot> do you have any notebooks we could add to the Speasy gallery :) ? That would be nice to add some more realistic use-cases here https://speasy.readthedocs.io/en/latest/examples/index.html. — Reply to this email directly, view it on GitHub <#104 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGIQQK4772NAOVYZDAPW6MTYBNZRJAVCNFSM6AAAAAA6RPNYGKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOBSGU2TEMZYGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[jeandet]

@nicolasaunai you can check the readme for the wording as we discussed about the introduction that was not user friendly.
@brenard-irap if you can review examples notebooks with @vgenot and also the new readme that would be awesome.