Merge pull request #174 from gvwilson/updating-readme-and-layout

Software Carpentry is an open source project,

and we welcome contributions of all kinds:

new lessons,

fixes to existing material,

bug reports,

and reviews of proposed changes are all equally welcome.

By contributing,

you are agreeing that Software Carpentry may redistribute your work under

[these licenses][license].

## Getting Started

1.  We use GitHub flow to manage changes,

    which is explained in the chapter [Contributing to a Project][pro-git-chapter]

    in Scott Chacon's book *Pro Git*.

2.  For our lessons,

    you should branch from and submit pull requests against the `gh-pages` branch.

3.  When editing lesson pages, you need only commit changes to the Markdown source files.

4.  If you're looking for things to work on,

    please see [the list of issues for this repository][lesson-template-issues],

    or for [our other lessons][swc-lessons].

    Comments on issues and reviews of pull requests are equally welcome.

## Other Resources

1.  This lesson is based on the template found at

    [https://github.com/swcarpentry/lesson-template](https://github.com/swcarpentry/lesson-template).

    That repository has instructions on formatting and previewing lessons.

2.  For a list of helpful commands run `make` in this directory.

3.  The [list of maintainers][swc-maintainers]

    on the [Software Carpentry website][swc-website]

    lists the people currently responsible for managing this repository.

    Feel free to contact them if you have any questions or languishing pull requests.

[lesson-template-issues]: https://github.com/swcarpentry/lesson-template/issues

[license]: LICENSE.html

[pro-git]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project

[swc-lessons]: http://software-carpentry.org/lessons.html

[swc-maintainers]: http://software-carpentry.org/lessons.html#maintainers

[swc-website]: http://software-carpentry.org

7.  `instructors.md`: the instructor's guide for the lesson. See

    "Instructor's Guide" below.

Note that the lesson's title is repeated in several files.  We could

8.  `CONTRIBUTING.md`: instructions for people who want to contribute.

    This file should be edited to replace references to `lesson-template`

    with references to your lesson's repository.

Note: the lesson's title is repeated in several files.  We could

put this in the Makefile, and insert it into pages when compiling, but

then authors would have to edit the Makefile (which we want to avoid).

We could also put it in some sort of configuration file, but again,

we're trying to avoid those.

We could also put it in some sort of configuration file, but they're

not a standard part of Pandoc, so we're avoiding them as well.

## Home Page

    *   Second point of general discussion.

Note: the discussion page is not meant to be more lesson material, so

it should not contain challenges and the like.  Instead, it should

give pointers to other lessons and tools that learners might find

useful, etc.

## Instructor's Guide

Learners may go through lessons outside of class, so it seems best to

    $ git remote add origin https://github.com/mcurie/data-cleanup

    ~~~

5.  Create and edit files (explained below).

5.  Create and edit files as explained in

    [Lesson Layout](LAYOUT.md),

    [Background and Design](DESIGN.md),

    and the [FAQ](FAQ.md).

6.  Build the HTML pages for your lesson: