Write report.md

[newsch]

What we need:

• overall goals of project

  What was the goal of your project; for example, what did you plan to make, and what was it supposed to do?

• Useful resources

  What resources did you find that were useful to you? If you ran into problems because you didn't find information you needed, consider putting that information in your report: write the tutorial you needed.

• What we did
  • code snippets and walkthroughs
  • example outputs

  What were you able to get done? Include in the report whatever evidence is appropriate to demonstrate the outcome of the project. Consider including snippets of code with explanation; do not paste in large chunks of unexplained code. Consider including links to relevant files. And do include output from the program(s) you wrote. Consider making a demo video.

• Learning Goals Reflection
  • Matt
  • Adam
  • Evan

  Reflect on the outcome of the project in terms of your learning goals. Between the lower and upper bounds you identified in the proposal, where did your project end up? Did you achieve your learning goals?

• Check context and audience

  Audience: Target an external audience that wants to know what you did and why. More specifically, think about students in future versions of SoftSys who might want to work on a related project. Also think about people who might look at your online portfolio to see what you know, what you can do, and how well you can communicate.

Some things that would be nice to have:

• a video from asciinema or similar
• some semblance of an idea for the presentation (6 minutes max)
• Usage instructions/project overview in the README
• releases from various states of the project
• an up-to-date release for demo day
• reword MVP for external audience

Report assignment
Presentation assignment