swc-git-example.git
10 years agoREADME.md: Document the syntax used in the README
W. Trevor King [Fri, 29 Nov 2013 22:33:29 +0000 (14:33 -0800)]
README.md: Document the syntax used in the README

Explain that the file is written in Markdown, and link to the Markdown
spec and GitHub's markup parsing docs.

After adjusting README.md in my text editor, I compared my working
directory with the index using:

  $ git diff

That looked reasonable, so I committed all the modifications using:

  $ git commit --all

The `--all` option tells Git to automatically stage any modifications
or deletions.  I could have used the following:

  $ git add README.md
  $ git commit

and achieved the same result.  Some people like to stage changes
explicitly, and some like to stage them automatically.  Pick whichever
works best for you.

10 years agoREADME.md: Begin versioning by explaining the project goals
W. Trevor King [Fri, 29 Nov 2013 22:29:06 +0000 (14:29 -0800)]
README.md: Begin versioning by explaining the project goals

I created this commit by writing README.md in my text exitor.  I
staged the file for the next commit with:

  $ git add README.md

I committed the staged version of the file with:

  $ git commit