Project Report

The project reports for this class will be prepared using Github Gists. I personally use Gist to share codes, documents, thoughts, and notes. Gists are great for short form discussions that are dependent on code or conveying an idea with minimal need for style.

Report Template

I have made a Report Template that the class can use to get started.

Making a Report Template

  • Create a New Gist

    private gists can be shared via a link and public gists can be perused on your gist profile.

  • Appending the Report Template

    The Report Template template is written in Markdown; so is this class post. Markdown is minimal stylized plain text syntax that is easily converted to HTML. I have provided links and documentation for Markdown below.

    Gists will be converted to Markdown when a Gist file *.md or *.markdown as an extension.

  • Iterate on the Document

    Amongst your team, use the comment box at the bottom of the Gist to improve and iterate on the document.

    Example - There is a comment from Dr. Kalidindi at the bottom of this Gist.

  • Submit the Document

    Make your Gist public and share it with us.

Pro Tip: Fork a Gist to edit the document contents yourself.

Markdown

Markdown is plain text to HTML conversion tool. Markdown uses minimal syntax to create both easy to read plan text and easy to format HTML. Markdown looks nice in email and on the web.

Advantages to Markdown

Easy to write. Easy to read. Easy to style… later.

Syntax

Interpretter

Try out Markdown with Daring Fireball Dingus.

Extensions

Markdown Preview for Google Chrome accesses and inteprets local and remote Markdown files into formatted HTML.