6 ms·
This is what I don't quite understand about the github atmosphere. How is it considered perfectly normal to introduce an application "...with enhancements" and
by sixothree 9y ago
This is what I don't quite understand about the github atmosphere. How is it considered perfectly normal to introduce an application "...with enhancements" and not include a screenshot.
- organsnyder 9y agoI think it's mainly a tooling issue—readme files are repo "homepages" by default, there isn't an easy way to inline an image in Markdown (nor should you want to), and people don't want to pollute a repo with binaries.
- sixothree 9y agoThis is why I am disappointed GitHub has become the defacto standard. It's not clear what this is or even why this exists. And that seems to be the case with the vast majority of projects on the site.
- jimwalsh 9y agoSo you want a better readme on most projects?
- sixothree 9y agoI think the readmd is the problem. There is something about the github itself, or the culture around it is the issue, since the problem seems so pervasive. I would prefer the site fosters better project information. Compare github project pages to what you would find at the now defunct codeplex. The difference was night and day.
- mikepurvis 9y agoGitHub Pages addresses this exact need, but it requires a small amount of additional work to set up vs. just tossing up a README file.
- sixothree 9y agoI would prefer a site that fosters better care.
- KallDrexx 9y agoEven better, a bunch of my older repositories now have broken images since I had to host the images outside of Github for them to show up in the markdown, so I hosted them on Dropbox. Dropbox has since taken down public hosting of images (or changed the method in which you can do it) so they are all broken (and I"m too lazy/repos are too low traffic for me to bother hunting it all down).
- koolba 9y agoI thought you can reference relative pathed images in the same repo.
- larrybud 9y agoNot sure I follow you saying it's not easy to inline images. See: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#images https://github.com/adam-p/markdown-here/wiki/Markdown-Cheats...
- organsnyder 9y agoYou still have to host the images somewhere—they're not embedded in the document (which is what I meant by "inline"). Not that I think markdown should be able to embed images (that would be contrary to the whole point of the format), but it doesn't lend itself to easy, one-click (or few-keystroke) images.
- larrybud 9y agoRe: "You still have to host the images somewhere—they're not embedded in the document (which is what I meant by "inline")" I still don't follow you; why is this an issue with markdown? Why do you see this as different than any other markup language (e.g, HTML)? Unless we're talking about something like Word documents, you'll have to host the image somewhere, which could be in your github repo. I still don't see why this is an issue.
- rdiddly 9y agoI also didn't get a good sense of "Why do this?" (Not being snarky.)
- tvon 9y agoIt has nothing to do with github, it is trivial and common to have images/screenshots/whatever in the in-repo documentation (or in the wiki).
- em3rgent0rdr 9y agoGitHub pages are for that. The git repo itself is for code.
- beenBoutIT 9y agoMost projects haven't taken advantage of it yet, but GitHub recently introduced the option to add a link to a website or product page.