Skip to content

docs(readme): Add simulator screenshot#99

Merged
j-g00da merged 2 commits intoratatui:mainfrom
deadbaed:readme-simulator
Jun 24, 2025
Merged

docs(readme): Add simulator screenshot#99
j-g00da merged 2 commits intoratatui:mainfrom
deadbaed:readme-simulator

Conversation

@deadbaed
Copy link
Copy Markdown
Contributor

Closing #96

@j-g00da
Copy link
Copy Markdown
Member

j-g00da commented Jun 24, 2025

I see we had a little race condition here.
I like your screenshot, can you revert your changes and add just the picture? I already modified the readme.

@j-g00da
Copy link
Copy Markdown
Member

j-g00da commented Jun 24, 2025

Also the picture path shouldn't be relative, or else this would cause a problem when we moved/renamed it in the future (images on crates.io and docs.rs would break)

@j-g00da
Copy link
Copy Markdown
Member

j-g00da commented Jun 24, 2025

nit: conventional commits, please make such commits/pr titles that can finish the sentence

When this is merged, it will... <commit message after ":">

So it should be "remove" and "add" instead of "removed" and "added".

I know there's no information about it yet, I still have to finish the contribution guidelines.

@deadbaed
Copy link
Copy Markdown
Contributor Author

Hehe, didn't see that! I'll update just the picture.

Also the picture path shouldn't be relative, or else this would cause a problem when we moved/renamed it in the future (images on crates.io and docs.rs would break)

Oh good catch, but how am I supposed to add a url to a file that does not exist yet?

Also, how can this end up in crates.io/docs.rs if I'm only editing readme.md, and not lib.rs?

@deadbaed
Copy link
Copy Markdown
Contributor Author

nit: conventional commits, please make such commits/pr titles that can finish the sentence
When this is merged, it will... <commit message after ":">

Thank you for the cheatsheet! I'm used to have my commits in the past tense.

@j-g00da
Copy link
Copy Markdown
Member

j-g00da commented Jun 24, 2025

but how am I supposed to add a url to a file that does not exist yet?

I often just do this in two commits, you can open a PR that just adds the image to assets and then use it here.

Also, how can this end up in crates.io/docs.rs if I'm only editing readme.md, and not lib.rs?

lib.rs pulls the docs from README.md .

@deadbaed deadbaed force-pushed the readme-simulator branch 2 times, most recently from 0312d75 to 7904516 Compare June 24, 2025 06:44
@deadbaed deadbaed changed the title docs(readme): Removed simulator feature, added simulator screenshot docs(readme): Add simulator screenshot Jun 24, 2025
@deadbaed
Copy link
Copy Markdown
Contributor Author

All good now!

@j-g00da j-g00da merged commit e2b4985 into ratatui:main Jun 24, 2025
24 checks passed
@github-actions github-actions bot mentioned this pull request Jan 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants