Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 937 Bytes

PROJECT_README_TEMPLATE.md

File metadata and controls

26 lines (19 loc) · 937 Bytes
Raw

{ Project Name }

Addressing { Challenge Name, include a link to the challenge }

Created by { Team Name }

  • List
  • Every
  • Team
  • Member's
  • GitHub handle and Full Name

Solution Description

You must provide a paragraph describing the solution in some detail. This must be an entire paragraph, more than one or two sentences. It should explain whatever approaches you took to the problem, what you think worked and what did not work, and describe potential future work to be done.

Installation Instructions

You must list by name all software packages, APIs, frameworks, databases, or any other tools or libraries you used.

You must also provide any step-by-step instructions for installation of your solution.

  • Step one - install package manager
  • Step two - special config instructions
  • Step three - system administration notes
  • Step four - command line how-to, listing descriptions of all optional arguments