Skip to content

HIVE.md generator

Build a HIVE.md file for the root of your repo. It stays in this browser until you copy or download it.

Fills in the barbershop example from the HIVE.md guide. Change any line.

The heading under the header. Leave blank and the file says Project name. The Hive Code does not read it. 0 / 80.

The tagline field. What it is, in one line, 10 to 120 characters. 0 / 120.

Add tagline: what the project is, in one line (10 to 120 characters). This fills in the listing.

The for field. 3 to 80 characters. 0 / 80.

Add for: who it's for (3 to 80 characters). This fills in the listing.

The problem field. 10 to 200 characters. 0 / 200.

Add problem: the problem it solves (10 to 200 characters). This fills in the listing.

The help_wanted field. Up to 200 characters. 0 / 200.

The run field. Up to 20 lines and 1000 characters, one command per line. These are copied as text. Nothing here runs them. 0 / 1000.

Deploy in one click

The deploy field. Only if the app deploys on Vercel or Netlify.

Shown under the heading. Leave blank and the file uses: Say more here in your own words: what it does today, what is next, and how to help. 0 / 2000.

Your file

Hive-ready score

0

out of 100

Not hive-ready yet

Not hive-ready yet. The file needs a header between two --- lines, with at least one field that passes.

# Project name Say more here in your own words: what it does today, what is next, and how to help.

  • FixHeader. The file has no header. Put the fields between two lines that are just ---.
  • FixTagline. Add tagline: what the project is, in one line (10 to 120 characters). This fills in the listing.
  • FixWho it's for. Add for: who it's for (3 to 80 characters). This fills in the listing.
  • FixThe problem. Add problem: the problem it solves (10 to 200 characters). This fills in the listing.
  • AddHelp wanted. Add help_wanted: the help you want right now (3 to 200 characters).
  • AddRun steps. Add run: the commands to run it on your own computer, up to 20 lines.
  • AddDeploy. Add deploy: vercel, netlify, or both, if people can launch their own copy in one click. Leave it out if that does not fit.
  • AddNote for readers. Add a short note under the closing --- so people reading the file on GitHub can see what the project is. The Hive Code does not read this part.

Already have a file? Check if it is hive-ready.

Get launch news.

The Hive Code is open. Join the waitlist if you want an email when the next piece ships. This page does not collect your email.

Join the waitlist

Read the guides