-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Add screenshots for all GitHub readme examples #41
Conversation
I suppose there is no way to embed the versioned screenshot of the README? Right now it links to the repository, which may not reflect the screenshot. Let's merge the other PRs, first, and then rebase this. I'm not sure I want this, as it makes the markdown inscrutable - will depend on @matiassingers thoughts. |
I'm not sure that you mean by that. It's possible to link to the target readme at commit at which the screenshot was made - just change the repo URL to include the current commit. Want me to do that? |
Exactly. That way, we won't get the issue like we had with dotfiles. I've gone through and merged the other PRs. Mind redoing the PR? :) |
Sure! Here, I've rebased the PR. Let me come up with a clever way to fetch a list of current commits for all repos. |
Documented everything in |
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.
Looks pretty good to me. One small nitpick.
contributing.md
Outdated
@@ -6,9 +6,13 @@ Please ensure your pull request adheres to the following guidelines: | |||
- Suggested READMEs should be beautiful or stand out in some way. | |||
- Make an individual pull request for each suggestion. | |||
- New categories, or improvements to the existing categorization are welcome. | |||
- Keep descriptions short and simple, but descriptive. | |||
- Start the description with a capital and end with a full stop/period. | |||
- When adding a new README, make sure to follow existing visual and code style: |
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.
Follow the existing visual...
Thanks, fixed that. |
This was a terrible idea because of the markup bloat. |
Well, yes and no. The implementation is very bloated. I think one thing we could do, rather easily, is just have a link to a screenshot, and not worry about the markdown at all. Just have a |
Yeah, I agree. I could also automate taking the screenshots themselves. Would you accept something like |
That would work for me. The only issue is that we need to make sure that the screenshots match the commit of the PR, not the most recent commit in whatever given README. |
... except for b4b4r07/dotfiles, that project has practically no readme at the time of this PR. Should probably remove it from the list.
All screenshots are 980 x 1064 == (width of GiHub layout) x (1080 display - minimal cropped header).
Please take a look at the HTML. It is good enough? I couldn't make it less verbose or translate to Markdown.
Please feel free to ignore this PR if this is not acceptable - it didn't make that much time since I managed to automate almost every step. :)
Edit: Live preview: https://github.com/deltaidea/awesome-readme/tree/screenshots
Closes #1.