Project README Template

A template for the project readme file.

Key Features • How To Use • Project Description • Data Locations

Key Features

In this section you will be including a list of key features of your code/project.

You should also include a short description of what each part of your code does. (Detailed description in the readme of each directory, if applicable)

• /path/to/directory - function and description
  • Key notes
• /path/to/script - function and description
  • Key notes
• Lorem Ipsum - Dolor Sit Amet
  • Consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
• Duis Aute Irure Dolor
  • Excepteur sint occaecat
• Excepteur Sint Occaecat
  • Curabitur efficitur, nunc non ultricies gravida, felis purus posuere eros, sed faucibus sapien est nec quam. Nulla at nisl nisl.

How To Use

To clone and run this application, you'll need Git From your command line:

# Clone this repository
$ git clone [repo link]

# Further Instructions
...

Create a new branch from dev, add changes on the new branch you just created.

You will want to look into git branch and git checkout

# Create and Checkout a new branch if it doesn't exist
$ git checkout -b your-branch main
...

Open a Pull Request to dev. Add your PM and TPM as reviewers.

At the end of the semester during project wrap up open a final Pull Request to main from dev branch.

Project Description

In this section, you should include the project description, either from the client or spark.

Please make sure it reflects what you see on the documents (project description) you recieved.

• Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla facilisi. Donec vel nunc at libero ultrices tincidunt. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Mauris ut ligula nec risus posuere ultricies at et ligula. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
• Veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Data locations

In this section, you should include the location of all of your datasets for the project (if applicable)

Dataset Documentation

• Location 1: [location]
  • [description]
• Location 2: [location]
  • [description]