-
Notifications
You must be signed in to change notification settings - Fork 22
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
docs(readme): Update README.md #413
Conversation
IMHO we miss the pip install line in the quickstart section. |
clear outputs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about adding gif to the README ?
This gif could be a notebook side by side with a skore ui demonstarting the UI.
I personally tend to read longer if I see images.
For inspiration see zoxide's readme which demonstartes the tool in a few seconds using a gif.
More inspiration in the awesome readme repo.
For a first iteration, it looks good to me, what do you think? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice improvement
- clearing outputs of the notebook - generating py (jupytext) - project.list_item_keys()
@sylvaincom this snippet will fix the
|
ba936bd
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To go forward I'll approve this and create an dedicated issue for the notebook pre commit hook.
IMHO readme assets should not be hosted outside of the repo. |
WIP, according to #411