This repository serves as a template for your team to create your own repository that you can use to submit your hackathon solution. You are not required to use this repository or GitHub to submit your solution, but you are required to submit all of your materials to us.
To use this repository, use the "Use this template" button to create a new repository (see instructions).
When creating a new repository, keep in mind:
- Your repository name must include your team name and your two-digit team ID (example:
my-awesome-team-99
) - You must create your team's repository under your own GitHub account or GitHub organization
- Your repository must be set to public
- Your repository must allow forking (this is the default when creating a new repository)
- Your repository must not be deleted until instructed otherwise by hackathon staff
After you create you repository from this template, submit your repository's URL to the hackathon staff on Slack. Please submit the full URL, such as https://github.com/octocat/Spoon-Knife. We will then fork your repository and keep our fork updated.
- The
slides
directory is for your team's final presentations. Please ensure your slides are in this directory at the time of judging. - You may place any and all files you wish to submit in this repository, using any project structure.
- Please consider keeping this README file, but delete all of this template text and customize it with helpful information about your solution. There is no specific format you should follow, but you can refer to the example sections below for some ideas.
In this section, you can briefly introduce the solution. Overall, what does it do? What problem does it solve?
In this section, you can describe the features your solution has.
In this section, you can describe how to get started with your solution. This could include configuring the environment and your solution, installing prerequisites, etc.
In this section, you can describe how to use the solution.
In this section, you can provide practical examples of how one would use the solution.