Added GitHub README

Hi all (@pdraper @matthieu @aborissov), please could you read through this README.md I've put together and suggest changes/improvements?

Cheers!

changed the description

Is this supposed to replace the current README?

I suppose it could, as it is just extra, but my thought was that this would be displayed on GitHub and our current one displayed on the GitLab

We could certainly enhance the standard README with some of this from the preamble.

@matthieu you happy with this statement. How many cores would we expect at exa-scale?

Yeah, I think exa-scale is probably a little strong.

I don't expect any x86-based exa-scale machine to have less than 10M cores... So there is some good metis work ahead before we can make that claim.

Technically, we have scaled up to 10s of thousands of nodes.

Perhaps it should just say that SWIFT scales well on up to petascale machines?

changed this line in version 5 of the diff

Would we be able to get one of these: https://wiki.jenkins.io/display/JENKINS/Embeddable+Build+Status+Plugin for the top?

added 1 commit

• 040811b2 - Removed claim about exascale (that one was a bit much)

Compare with previous version

OK, if you go to:

• https://gitlab.cosma.dur.ac.uk/jenkins/

and select a project you should find the Embeddable Build Status links in the left-hand panel. Press for more instructions.

added 1 commit

• 233b6bfb - Added build status logo

Compare with previous version

Is everyone happy for this to be merged in?

assigned to @matthieu

added 1 commit

• e0880e06 - Minor improvements to the README.md

Compare with previous version

I have made some small changes. Let me know what you think.

unmarked as a Work In Progress

added 1 commit

• fcf437dc - re-jigged README a bit to make more sense

Compare with previous version

Looks good to me. I have rearranged stuff so that it makes a bit more sense.

merged

mentioned in commit b4404903

Approved, thanks!

And has been pushed to github last night. Thanks.