CSS Carousel Configurator (chrome.dev)

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 (3)

speedylight · 50m 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.

nyoki · 3h 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

CSS Carousel Configurator (chrome.dev)

CSS Anchor Positioning Tool (chrome.dev)

China makes first 5G satellite-to-phone video call (scmp.com)

Generate Big Deals on Reddit Without Being Salesy (docs.google.com)

Dev Problems (builtfor.dev)

Please Fund More Science (2020) (blog.samaltman.com)

A Hugo Survival Guide (2022) (janert.me)

Addressing Criticism of RISC-V Microprocessors (2022) (medium.com)

Paper Is Good (dynomight.net)

The genetic medicine of the future will be able to treat everything (english.elpais.com)

The Who Cares Era (dansinker.com)

Crypto Investor Charged with Kidnapping and Torturing Man for Weeks (nytimes.com)

Company patented "ceiling fan" drone but it was already open source (twitter.com)

Apple is hitting back in the war over internet age-gating (theverge.com)

Lone coder cracks 50-year puzzle to find Boggle's top-scoring board (ft.com)

Cybercrime orders of magnitude more than state-backed ops: exWhite House advisor (theregister.com)

Apple helped China become America's biggest tech rival (thetimes.com)

Exposed Industrial Control Systems and Honeypots in the Wild [pdf] (gsmaragd.github.io)

Show HN: I built a free AI-powered Pocket alternative (apps.apple.com)

Being God Is a Big Responsibility (qntm.org)

Infinite Feed Design Sucks (aphantasia.io)

The loudest mechanical keyboard features relays and firecrackers to make noise (tomshardware.com)

Ncdu 2.8 – NCurses Disk Usage (dev.yorhel.nl)

Go Beever AI

Timebot – A Time and Frequency Expert System (timebot.febo.com)

LLM Friendly Projects (davidgasquez.com)

Show HN: Unsiloed Chunker – VLM powered semantic chunking for RAG (github.com)

Show HN: Made a free tool for affiliate marketers to fix in-app browser issues (link-it.bio)

Show HN: Berb (Update) – WebRTC File Sharing (berb.app)

Record number of Americans seeking UK residency, says Home Office (theguardian.com)

My TV Remote Stopped Working So I Made My Own (thestockpot.net)

Lo8: Resurrecting the 8-track as a data storage medium – Cassettepunk (cassettepunk.com)

IonQ CEO on the potential of quantum computing, the quantum trade and growth (cnbc.com)

Concept of a fusion rocket that could halve the journey time to Mars (gizmodo.com)

Apple Used China to Make a Profit. What China Got in Return Is Scarier (nytimes.com)

Having your compile-time cake and eating it too (0x44.xyz)

Feedback on my Snow Days Calculator project

Venera 8 Kosmos 482 descent craft reentry forecasts (sattrackcam.blogspot.com)

Remote Control at Nuclear Power Plants (blog.ucs.org)

Online Planning Tool Could Easily Save Your Life During a Grand Canyon Hike (explore.com)

The CSS anchor positioning API (developer.chrome.com)

Use ramoops for logging under Linux (2021) (embear.ch)

Tokei: Count Your Code, Quickly (github.com)

CSS Relative Color Syntax (developer.chrome.com)

Please don't upload my code to GitHub (nogithub.codeberg.page)

Not in My Name: An Open Letter to Microsoft from Brian Eno (stopwar.org.uk)

It Is Time to Stop Teaching Frequentism to Non-Statisticians (2024) (arxiv.org)

Return to the Text (2022) (im1776.com)

CSS-Text-Wrap: Balance (developer.chrome.com)

Show HN: Terminal Flower Garden (github.com)

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

Comments (3)