[HN Gopher] Show HN: Pimp My Readme
___________________________________________________________________
Show HN: Pimp My Readme
Author : joshdsouza
Score : 70 points
Date : 2021-10-24 17:00 UTC (6 hours ago)
(HTM) web link (pimp-my-readme.webapp.io)
(TXT) w3m dump (pimp-my-readme.webapp.io)
| redwoolf wrote:
| I'm not a fan of the use of the word "pimp" in this context.
| Pimps can be involved in sexual exploitation and sexual
| traficking. Plus, I don't feel comfortable using this word in a
| professional context. I would never be able to suggest using this
| otherwise fun and whimsical project at work.
| sodality2 wrote:
| >I'm not a fan of the use of the word "pimp" in this context
|
| In this context it means "to adapt or embellish in an
| ostentatious manner".
| mattbaker wrote:
| Yeahhhh but the context doesn't negate the fact that the word
| is a reference to exploitation. I'm with the parent comment
| on this one. If it was 2005 I probably wouldn't have blinked
| but ya know, the world moves on.
|
| There are just so many names to pick from! I find the choice
| very confusing. Too cringe-y for me to consider sharing or
| using personally, but I'm sure some will and I hope they
| enjoy it.
| siva7 wrote:
| Words can have many different unrelated meanings, based on
| context. Going with sexual exploitation is beyond absurdity
| when Pimp my X is a well-known cultural reference
| woodruffw wrote:
| I'm pretty sympathetic in this case, but to point out the
| obvious: something being a "well-known cultural
| reference" isn't itself a strong justification for using
| language or symbols that are known to be offensive.
|
| An intuitive case for most people: we all recognize the
| car from The Dukes of Hazzard, but you probably shouldn't
| put the confederate battle flag on your own car as a
| reference to it.
| zyemuzu wrote:
| Give it a break, everyone knows and understands this context of
| 'pimping' something.
|
| The endless virtue signalling is so tiresome.
| woodruffw wrote:
| It isn't apparent to me to me that this person has "virtue
| signaled" by expressing their opinion. Why dive immediately
| for sinister motivations when someone says that a particular
| piece of language makes them uncomfortable?
| [deleted]
| divbzero wrote:
| Love the 90s nostalgia. Could also add something like...
| <blink>🏗 This page is under construction.
| 🚧</blink>
| joshdsouza wrote:
| Haha that's a great idea! Let's bring the blink tags back, I'll
| add it in tomorrow.
|
| Also project is open source as well so if you have any ideas,
| you can open an issue for it (which I will get to) or just add
| it in whenever you can :)
| jdauriemma wrote:
| Thank you for sharing! For those using this service, please keep
| in mind that screen readers are not able to access text in
| images. Since the markdown output does not contain `alt` text,
| use care when copypasting this into your `README.md`; someone who
| is visually impaired will not be able to perceive it.
|
| Further reading: https://www.w3.org/TR/WCAG20-TECHS/H37.html
| joshdsouza wrote:
| Thanks for catching this! I'll make an update adding the alt
| text as default when copy & pasting
| joshdsouza wrote:
| Hey, I'm Josh & I wanted a way to add some customization to my
| readme, so I made this at my company hackathon last week.
|
| This is an open source project so if you want to contribute just
| add your component and put up a PR. Thanks for your feedback!
|
| GitHub repo here: https://github.com/joshdsouza8/pimp-my-readme
| elanning wrote:
| Awesome hackathon project. The font scroll is great 90s website
| nostalgia.
| joshdsouza wrote:
| Thanks! 90s web nostalgia is what I was going for :P
| rob74 wrote:
| The emojis in the "Hey, I'm Jellybear!" marquee line look more
| like "octopus-bear" (or "octobear", to compliment GitHub's
| "octocat"?). Not sure if there's a jellyfish emoji though...
| smusamashah wrote:
| I previously used something like that to add number of visitors
| on a repos Readme. Now it shows a broken image icon only because
| that service has been shut down.
|
| Best option to use it continously is to host your own version and
| use that instead of the one you are providing.
| joshdsouza wrote:
| Thanks for the feedback! I got permission to host the project
| on my company's website after the hackathon, so it will be up
| indefinitely ;)
|
| There's also the option to just clone the repo, run, and host
| the server on your own as well, up to you.
| andrew_ wrote:
| Using the Facebook social icon given current events is just a
| smidge tone deaf.
| andrew_ wrote:
| I would genuinely like to read the rebuttals from folks who've
| downvoted this. Please, share your perspective.
| humpday69 wrote:
| Sorry to be that guy but are we really going with "pimping" in
| 2021? After that master branch thing I thought we were trying to
| be less edgy with naming.
| woodruffw wrote:
| I've noticed a lot of projects in the past few years put a lot of
| stuff like this in their READMEs, with the (presumable) end goal
| of making their repository really "pop" on GitHub. That's
| perfectly fine! But sometimes it goes so far as to actively
| impede _reading_ the README in a text editor, since it 's now
| full of tables and Markdown abuse aimed at making it render
| correctly on GitHub. It also has a tendency to break other sites
| (think package management indices) that tend to consume READMEs,
| as they're now being fed all kinds of weird GitHub-specific
| Markdown. That leads to an overall worse user experience, e.g.
| when I'm selecting a package from PyPI or crates.io.
|
| Given that projects are now using their READMEs as de-facto
| `index.html` pages, we really ought to just have an `INDEX.md` or
| similar convention for presenting all the cute stuff.
| mmahemoff wrote:
| Ideally those tools would render a file called README.md as
| readable HTML.
|
| For example, w3m renders this project's README cleanly -
| https://ibb.co/WPDDL0d
| woodruffw wrote:
| That would be ideal, yeah. But I don't begrudge them for
| failing to do so: GitHub-flavored Markdown is a significantly
| more complicated beast than "common" Markdown, which is
| itself somewhat fragmented.
| [deleted]
| denton-scratch wrote:
| I can't read your README; I can't scroll down. Sorry.
| joshdsouza wrote:
| Hey, could you give me a little more detail on what you're
| seeing (i.e. what browser are you using), would love to fix it
| so you can check it out. Thanks!
| denton-scratch wrote:
| It seems to have improved now - I can scroll fine.
|
| This is still the same browser session.
|
| I'm on a laptop running FF 93.0, with Noscript and Adblocker
| Ultimate, both enabled. FF is running full-screen. It's
| Win10.
|
| I didn't record what I saw earlier. Now, I see a number of
| clickable placeholder images, and a bunch of "Try me"
| buttons. My impression is that the site is for making
| marketing-friendly tags. That's cool, just not my thing. I
| didn't click.
___________________________________________________________________
(page generated 2021-10-24 23:00 UTC)