Add instruciton how to setup an env for developers

[paulromano]

The quickstart documentation mentions an examples/ directory that doesn't seem to exist in the Nek5000 repo anymore (I gather those moved to the NekExamples repo). Along the same lines, the Running your first simulation doesn't work because there's no examples directory.

[dshaver-ANL]

It's not an error. The examples directory is included in the tarball, but NOT on the github repo. The tarball is the recommended method of downloading the code. See issues #62 and #63 for further info.

All that being said, I will leave this issue open until the documentation is more clear on this.

[paulromano]

Ah, my mistake. Nevertheless, people who are git-savvy are more likely to clone the repo than to download a tarball, so I agree making it clearer in the documentation that the instructions only work with tarballs would be a good idea.

[stgeke]

Note, the tarball constains the nek source, examples, documentation (in the future) and all required 3rd party code. That's why we strongly recommend to always use the latest release which is only avaiable as a tarball. This is explained in the quick start:

All release tarballs can be found here. We do not recommend using the master branch on GitHub in a production environment!

Is this not clear enough?

[paulromano]

It's perfectly clear if you take the time to read it :) Again, someone git-savvy will see the first section titled "Downloading the code" and may say to themselves "I know how to do that already". It wouldn't hurt to put a reminder in the "Running your first simulation" section.

[stgeke]

Just want to point out that if you miss this important information you may run into other issues (incompatible 3rd party versions etc.).

[paulromano]

Good to know. It might be worth having a separate developer's guide that discusses setting up a proper environment with git then for people who are interesting in contributing to the code and need to be working off the master branch.

[stgeke]

I agree, that's a good idea!

[dshaver-ANL]

Okay, I added some extra warnings about not trying to clone the master branch. I think the initial issue here is closed, but I'm going to change this to "developer's guide".