arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Sample Project Template

  • Team: Pito Salas (rpsalas@brandeis.edu) and Charlie Squires (charliesquires@gmail.com)

  • Date: xxx

  • Github repo: xxxx `

hashtag
Introduction

Use this template as a starting point. You can add sections if you need to by preceding them with the double pound sign,

  1. You can make a numbered list

  2. By doing this

  • And a bulletted list like

  • This by putting in asterisks

hashtag
Problem Statement

  1. Write a useful summary for the future

  2. Show off your work

hashtag
learning Objectives

  • Learn a little bit about markdown

  • Learn the importance of spelling, grammar and editing

  • Look at the result in the browser to make sure it looks right

hashtag
Relevant literature

hashtag
What was created

We created a single markdown file explaining our product.

hashtag
Technical Description, illustrations

hashtag
Discussion of interesting algorithms, modules, techniques

hashtag
Guide on how to use the code written

hashtag
Clear description and tables of source files, nodes, messages, actions and so on

hashtag
Story of the project.

hashtag
How it unfolded, how the team worked together

hashtag
problems that were solved, pivots that had to be taken

hashtag
Your own assessment