Try a generator

README Generator

Fill in the project name, what it does, the stack and how to run it. The generator recognises your stack and adds the matching prerequisites, deployment notes and structure section on top of what you typed.

Comma-separated. Recognised stacks get prerequisites, structure and deployment sections added automatically.

One per line.

One command per line, in order.

One per line: NAME - what it is. Leave empty to skip the section.

Takes a second. Your answers are used to build the file and to improve the generator; see the privacy policy.

README.md 
 Fill in the form; a live preview of your document builds here. Press Generate for the full version.