Skip to content

Instantly share code, notes, and snippets.

@BlakeCampbells

BlakeCampbells/readme.md

Last active December 15, 2022 22:47
Show Gist options
  • Star 8 You must be signed in to star a gist
  • Fork 2 You must be signed in to fork a gist
  • Save BlakeCampbells/58b72751eae87f6891d0fc357298e299 to your computer and use it in GitHub Desktop.
Save BlakeCampbells/58b72751eae87f6891d0fc357298e299 to your computer and use it in GitHub Desktop.
Download ZIP
Better Readme Outline
Raw
readme.md

Project Name

Overview

  • What does this project do?
  • Who is it for? What goals does this accomplish?

Setup

  • Requirements for running the project

Tech

  • What technologies are you using?
    • Frontend/Backend key libraries that are good to know.
    • Add links to their documentation if you can example VueJS Docs
  • How can I get started running this project?

Project Architecture

  • How did you set up the project?
  • Where is key logic happening?
  • What are you integrating with?

Testing / Formatting

  • What kind of tests does this have? What formatting rules should I follow?

FAQs

  • Confusing parts of the repo.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment