Completing the Developer Guide

[leouieda]

Writing some more sections for the Developer Guide.

• Getting started: sign up for Github, make a fork, etc
• Setting up: install things, setup environment variables
• Building: compiling C extensions and Cython
• Testing: unit and doctests
• Code style: PEP8 and the auto checker
• Documentation: building and serving the docs

I tried to include some links to reference material for those new to software development. Most are links to Software Carpentry.

There is a version of the docs of this PR on ReadTheDocs: http://fatiando.readthedocs.org/en/devel-guide/develop.html

It will be updated automatically with the PR.

Fixes #25 (probably all of it)

Checklist:

• Code and docs have been spellchecked
• Changelog entry
• Include new dependencies in docs, requirements.txt, README
• Documentation builds properly
• All tests pass
• Can be merged

[coveralls]

Coverage remained the same when pulling fa3bdf8 on devel-guide into 246b4d7 on master.

[hbueno]

Hi @leouieda, I found your text very clear and concise.

[leouieda]

Hi @leouieda, I found your text very clear and concise. I've one suggestion but far away to be relevant. Maybe put a link in "scope of the project" which points to a brief description already done (e.g, this overview https://github.com/fatiando/fatiando/blob/devel-guide/doc/index.rst) or another one more detailed (?).

That is a very good suggestion. We've been needing a nice and clear mission statement. Something like this for the khmer project.

I'll try to come up with a draft for that but I'll leave it for another PR (and another section of the docs). It might be better placed in the front page. I've opened #145 for this so we can move this particular discussion there.

[coveralls]

Coverage remained the same when pulling 19e5750 on devel-guide into 246b4d7 on master.

[coveralls]

Coverage remained the same when pulling 4131244 on devel-guide into e0b1b95 on master.

[coveralls]

Coverage decreased (-0.01%) when pulling 6231643 on devel-guide into e0b1b95 on master.

[leouieda]

@hbueno any other suggestions for this? Just as a reminder, there is a compiled version on read the docs: http://fatiando.readthedocs.org/en/devel-guide/develop.html

[hbueno]

No, it's ok for me.

[leouieda]

Merging this then. If anything else comes up we can always open a new one.