Make a README

What it does

Includes an introduction to READMEs, suggestions for content, and an editable template with live Markdown rendering.

Learn how to make a great README for your programming project, and use the editable template to get started.

A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about. It's an easy way to answer questions that your audience will likely have regarding how to install and use your project and also how to collaborate with you. Anyone who is working on a programming project, especially if you want others to use it or contribute. Definitely before you show a project to other people or make it public. You might want to get into the habit of making it the first file you create in a new project. In the top level directory of the project. This is where someone who is new to your project will start out. Code…from makeareadme.com

• 
  ReadMe2014 · readme.com · ▲601

  Beautiful Documentation Made Easy

• 
  readme.so2021 · readme.so · ▲85

  Easily create the perfect readme for your project

• RI
  ReadMe.io – Beautiful Documentation Made Easy2014 · readme.io · ▲266

  ReadMe helps you create beautiful, interactive API documentation that developers love.

• 
  readMD2022 · readmd.itsvg.in · ▲96

  Create awesome readme in less than 2 minute and stand out

• 
  ReadSpark2024 · readspark.vercel.app · ▲114

  Focus on your Projects, not the ReadMe

• 
  Readme Template2021 · github.com · ▲6

  A Readme Template For Tomorrow's Opensource

• 
  Run full iOS 16.5 firmware on Android Devices▲536

  Contribute to oosexgang/hackios-xnu-kernel development by creating an account on GitHub.

  Dev tools · 6d ago · github.com

• 
  /dev/null▲503

  a social network for devs

  Dev tools · 9d ago · dev-null.sh

• 
  OpenBot▲362

  Grok Bot alternative: free, local, open-source, multiplayer

  Dev tools · 29d ago · openbot.run

• 
  Talanoa▲346

  Hi HN, I’m a fullstack developer, and honestly, I’ve lost count of how many side projects I’ve worked on over the years. But one idea kept coming back to me: a different kind of email client. It first came to me in 2014: “What if we could handle emails more like conversations?” Every year, I’d revisit this concept in my “Build Notes.” Ten years later, no one had built exactly what I had in mind — so I finally decided to do it myself. That’s how Talanoa was born. I wanted something focused on people, not timelines. I was tired of marking messages as unread just to remember to reply later, or…

  Dev tools · 26d ago · talanoa.email

• 
  myPip▲273

  Vibe code, publish, and monetize games with AI

  Dev tools · 12d ago · mypip.dev

• 
  Doneas▲273

  A daily accountability call with other entrepreneurs.

  Dev tools · 19d ago · doneas.com

• 
  Buy Me a Coffee▲1,411

  A simple, meaningful way to fund your creativity.

  Growth · 2018 · buymeacoffee.com

• 
  Robinhood Crypto▲1,208

  Zero-fee cryptocurrency trading from Robinhood 💸

  Commerce · 2018

• 
  Launchaco 2.0 🦄▲1,113

  Simple landing pages for your startup

  Dev tools · 2018

• 
  Indie Hackers Community▲1,095

  Work together to build profitable businesses & side projects

  Work · 2018 · indiehackers.com

• 
  Typeform 2.0▲793

  Build beautiful conversational forms, surveys and more

  Life & fun · 2018 · typeform.com

• 
  Resume.io▲731

  Build your job-winning resume in minutes

  Work · 2018 · resume.io