Our Notes on Documentation & Git

Compiled by Henry & Vipul

Markdown

• GitHub's Github Flavored Markdown Guide
• The original (Daring Fireball) Markdown Reference
• MultiMarkdown is an extended version of Markdown
  • GitHub repo for MultiMarkdown V5
  • MultiMarkdown's Official Website
• Markdown (and other Text Editors) Editors.pdf)SublimeText
  • GitBook Editor

Project Management

• We really like Slack
• Version Control
  • Dropbox, Google Drive (and the like) are sudo-version control software wrapped up in a GUI (graphical user interface). They handle a lot of the similar problems (though with less covers for worst-case situations) and bundle other services on top of them.

Git

GIT is a version control software, that keeps a track on the changes made to a file, so we can jump back to previous edition of the file. It allows to work on parts separately and then merge them together. We can branch i.e; parallely work on different iterations of the same project and select to keep one or merge parts from the various interactions to form a new one. Git is distributed, every user has a separate repository, which he then merges into the main repository. Here's a good tutorial conveniently compressed into just 15 minutes.

Cheat Sheet

Some tutorials:

• https://try.github.io/levels/1/challenges/1
• https://www.atlassian.com/git/tutorials
• http://www.vogella.com/tutorials/Git/article.html

pull -> work -> commit -> work -> commit -> pull -> merge -> push