Update README with the help of Copilot #1895
Conversation
This reverts commit 8e09ea8.
|
Looks good. A bit too happy on starting sensences with emotes, tho. The ones in the comments in cpp example code got to go. Really liking the table structures. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #1895 +/- ##
==========================================
- Coverage 82.85% 82.81% -0.04%
==========================================
Files 291 291
Lines 51565 51592 +27
Branches 11162 11208 +46
==========================================
+ Hits 42723 42725 +2
- Misses 7646 7701 +55
+ Partials 1196 1166 -30
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| </picture>, | ||
| __Android__ | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://github.com/PcapPlusPlus/pcapplusplus.github.io/raw/master/static/img/os-logos/logo-apple-dark.png"/> | ||
| <img src="https://github.com/PcapPlusPlus/pcapplusplus.github.io/raw/master/static/img/os-logos/logo-apple.png" alt="macOS" width="48" height="48"/> |
There was a problem hiding this comment.
We should remove the Apple Logo here as there is no Windows, Linux Android ,etc Logo
There was a problem hiding this comment.
Actually there are other logos but for some reason they are not properly download/render from time to time. Refreshing the page solves it. I don't know why
|
Please also put the screenshot of the new file. |
|
@tigercosmos you can check the rich diff, it visualizes the changes. 
|
|
@Dimi1010 Thanks, I didn't know that. |
|
@tigercosmos Or you can check my forked repo https://github.com/egecetin/PcapPlusPlus/tree/improve-readme it also renders it |
|
I think this version of the README has too many emojis and icons. It's also very "noisy" and has way too much details. We can probably take some of it, but I would make it simpler |
|
@egecetin I think Copilot has some good ideas about the design, but I'd take what we have now and improve it instead of letting it revise the entire file:
|
|
@seladb Sure I'll work on it |
|
@egecetin, one reminder: please also update the translations. |
Created with Copilot's Claude Sonnet 4 model and some minor human corrections :)
I asked copilot to update README file to make it visually appealing. To be honest I'm impressed with the result. It is looks like modern and attractive. Let me know what you think? @seladb @clementperon @Dimi1010 @tigercosmos
If anyone is currently using the library or considering using it and sees this PR/comment, please share your thoughts also