[Name of the Project] : [Team Number]

Members

Project Manager: [Name] ([GitHub Name])
Communications Lead: [Name] ([GitHub Name])
Git Master: [Name] ([GitHub Name])
Design Lead: [Name] ([GitHub Name])
Quality Assurance Tester: [Name] ([GitHub Name])

About Our Software

Describe a little about what the project is about here.

Platforms Tested on

• MacOS
• Android
• iOS
• Linux
• Windows

Important Links

Kanban Board: [link]
Designs: [link]
Styles Guide(s): [link]

How to Run Dev and Test Environment

Dependencies

• List all dependencies here
• Don't forget to include versions

Downloading Dependencies

Describe where to download the dependencies here. Some will likely require a web download. Provide links here. For IDE extensions, make sure your project works with the free version of them, and detail which IDE(s) these are available in.

Commands

Describe how the commands and process to launch the project on the main branch in such a way that anyone working on the project knows how to check the affects of any code they add.

Example terminal command syntax

It is very common in these sections to see code in peculiar boxes to help them stand out. Check the markdown section of the Project Specifications to see how to add more / customize these.

def code_highlight_example(m: int, m: float, s: str) -> str:
	return s + str(n*m)

public static void main(String[] args){
	System.out.println("Hello, World!");
}

static void Main(){
	Console.WriteLine("Hello, World!");
}