Closed gmyenni closed 5 years ago
I like the idea of keeping the instructions all in one place (one the website). However the replacement README doesn't seem to fit this repo, since it's basically additional thoughts related to our workflow. If we think this stuff is worth saying then I could see it being included on the updating data website or we can just leave that stuff to the paper. I think either is fine, but I think including this extensive discussion here will just be confusing.
It doesn't have to be this text. I was just thinking something that explains what the repo is and why it exists. I had sections (why the versioning code, why the archiving code, etc.), but we could do something much simpler.
I think shorter and simpler with links to the paper for more details sounds right to me, but that's just my personal take after a quick read and I'm happy for it to be ignored.
Link to website instead of including steps here, add description and motivation sections