frontpage.
newsnewestaskshowjobs

Made with ♥ by @iamnishanth

Open Source @Github

Open in hackernews

Ask HN: Can you give tips on writing a README for project?

2•vseplet•4h ago
I'm currently finishing up the initial version of my experimental embeddable library designed for creating web applications without a build step. But I'm not sure how to make the repository appealing and successful — something that makes people want to try it out, maybe even contribute or improve it.

https://github.com/vseplet/morph?tab=readme-ov-file#morph

So, I'd really appreciate any tips you have on writing a great README or structuring the repo — or pointing out any common mistakes I might have made along the way.

Comments

nyoki•4h ago
Tom Preston-Werner (GitHub, SemVer, Jekyll, etc.) has a great blog post about writing README files.

https://tom.preston-werner.com/2010/08/23/readme-driven-deve...

> As a byproduct of writing a Readme in order to know what you need to implement, you’ll have a very nice piece of documentation sitting in front of you. You’ll also find that it’s much easier to write this document at the beginning of the project when your excitement and motivation are at their highest. Retroactively writing a Readme is an absolute drag, and you’re sure to miss all kinds of important details when you do so.

vseplet•1h ago
This idea shocked me with its simplicity, thank you
speedylight•1h ago
I’d suggest looking at other popular repos for inspiration. But at the very least you README should have information on how to run the program as an end user as well as a guide for developers on how to set up the dev environment such that they’re ready to go by following it.

Also a basic description of what your app is/does and what’s it’s trying to solve, a video demonstration also goes a long way. Make sure you use tags on the repo, it’s help with search discovery.

Santa Cruz IT Assistant

1•itsmeWB•39s ago•0 comments

What I discovered when I asked Amazon to tell me everything Alexa had heard

https://www.theguardian.com/technology/2025/may/24/what-i-discovered-when-i-asked-amazon-to-tell-me-everything-alexa-had-heard
2•robaato•2m ago•0 comments

Bash implementation of Tabloid, the clickbait programming language

https://github.com/notweerdmonk/tabloid.bash
2•thunderbong•13m ago•0 comments

Supplements Linked to Reduced Fertility in Male Bodybuilders

https://bioengineer.org/branched-chain-amino-acid-bcaa-supplements-linked-to-reduced-fertility-in-male-bodybuilders/
2•geox•14m ago•0 comments

QR code generator that works entirely in the browser

https://justaqrcode.com/
2•NotInOurNames•14m ago•0 comments

Apple Rejects My Name Because It Contains "Dek" – But "Dick" Is Allowed

3•Kevin605•18m ago•0 comments

The Space Economy to Reach $944B by 2033

https://spacenews.com/the-space-economy-to-reach-944-billion-by-2033-novaspace-unveils-key-insight/
2•ricecat•18m ago•0 comments

Ken Rogoff on How Crypto Is Cutting into the Dollar's Hegemony

https://www.bloomberg.com/news/articles/2025-05-24/crypto-is-infiltrating-the-dollar-s-hegemony-says-ken-rogoff
2•wslh•19m ago•1 comments

Laravel Comments Package

https://github.com/usamamuneerchaudhary/commentify
1•umun•20m ago•0 comments

CSS Carousel Configurator

https://chrome.dev/carousel-configurator/
1•stefankuehnel•23m ago•0 comments

CSS Anchor Positioning Tool

https://chrome.dev/anchor-tool/
1•stefankuehnel•24m ago•0 comments

China makes first 5G satellite-to-phone video call

https://www.scmp.com/news/china/science/article/3311108/china-makes-worlds-first-5g-satellite-phone-video-call-will-it-test-us-tiktok-curbs
1•mooreds•24m ago•1 comments

Generate Big Deals on Reddit Without Being Salesy

https://docs.google.com/document/d/1E7jXd7M_07nDD50xmU7CL3JJ3jYcjxA8WyxxNxLqhKU/edit?tab=t.0
1•mooreds•26m ago•0 comments

Dev Problems

https://builtfor.dev/99/
1•mooreds•26m ago•0 comments

Please Fund More Science (2020)

https://blog.samaltman.com/please-fund-more-science
2•ssuds•27m ago•0 comments

A Hugo Survival Guide (2022)

https://janert.me/guides/hugo-survival-guide/
1•Tomte•28m ago•0 comments

Addressing Criticism of RISC-V Microprocessors (2022)

https://medium.com/codex/addressing-criticism-of-risc-v-microprocessors-803239b53284
1•Tomte•29m ago•0 comments

Paper Is Good

https://dynomight.net/paper/
2•homarp•29m ago•0 comments

The genetic medicine of the future will be able to treat everything

https://english.elpais.com/health/2025-05-24/carl-h-june-creator-of-car-t-therapies-the-genetic-medicine-of-the-future-will-be-able-to-treat-everything-from-diabetes-to-chronic-infections.html
1•dxs•30m ago•0 comments

The Who Cares Era

https://dansinker.com/posts/2025-05-23-who-cares/
2•hjuutilainen•34m ago•1 comments

Crypto Investor Charged with Kidnapping and Torturing Man for Weeks

https://www.nytimes.com/2025/05/24/nyregion/crypto-investor-torture-italian-tourist.html
2•2OEH8eoCRo0•35m ago•1 comments

Company patented "ceiling fan" drone but it was already open source

https://twitter.com/Nicholas_Rehm/status/1925733974510383114
2•felineflock•37m ago•0 comments

Apple is hitting back in the war over internet age-gating

https://www.theverge.com/internet-censorship/673771/apple-texas-age-verification-law-objection-tim-cook
1•chriskanan•38m ago•0 comments

Lone coder cracks 50-year puzzle to find Boggle's top-scoring board

https://www.ft.com/content/0ab64ced-1ed1-466d-acd3-78510d10c3a1
2•DavidSJ•40m ago•1 comments

Cybercrime orders of magnitude more than state-backed ops: exWhite House advisor

https://www.theregister.com/2025/05/24/cyber_crime_bigger_than_nation_state/
3•rntn•44m ago•0 comments

Apple helped China become America's biggest tech rival

https://www.thetimes.com/business-money/technology/article/how-apple-helped-china-become-americas-biggest-tech-rival-8f83tttv5
6•felineflock•46m ago•1 comments

Exposed Industrial Control Systems and Honeypots in the Wild [pdf]

https://gsmaragd.github.io/publications/EuroSP2025-ICS/EuroSP2025-ICS.pdf
4•gnabgib•49m ago•0 comments

Show HN: I built a free AI-powered Pocket alternative

https://apps.apple.com/us/app/eyeball-ai-bookmarks-notes/id6670705634
2•quinto_quarto•50m ago•0 comments

Being God Is a Big Responsibility

https://qntm.org/responsibilit
1•ko_pivot•52m ago•0 comments

Infinite Feed Design Sucks

https://aphantasia.io/graph/2534
2•Aikaros•53m ago•1 comments