Resolve "Add suggested acknowledgements to the README"

Closes #253 (closed)

changed milestone to %0.4.0

added Documentation label

added 1 commit

• cbd91d9c - Add citation guide to readme

Compare with previous version

approved this merge request

unmarked as a Work In Progress

@paul-lasky @colm.talbot @matthew-pitkin @moritz.huebner I'd appreciated eyes on this to make sure we are crediting everyone we think we should be. For ease, I just went for the github page links since not everyone has a paper/zenodo, this was the documentation is as good as their README

It would be good to have this in the docs too. Could you add what you've written into a citation.txt file in docs and include it in the index?

added 1 commit

• 5fe6aeef - Add pyMC3 add sub sections

Compare with previous version

added 1 commit

• 7b426584 - Make section titles just bold

Compare with previous version

resolved all discussions

@matthew-pitkin it is a good idea to have this in the documentation as well, but in practise I can't figure out how to read in a file content into the README.md. It would be unwise to have two copies of the information as that requires maintaining both, so one needs to have a single citation.txt file which is then sourced for both the documentation and into the README.

Of course, one could also only put it in the documentation, but I actually think this should be front and centre as a reminder to people, rather than hidden in the docs where few people will look in practise.

approved this merge request

approved this merge request

mentioned in commit 09c54d92

merged

@matthew-pitkin , sorry for not waiting to resolve the discussion with you. I've merged it just with the citations in the README. It would be good to add them into the documentation, just need to think about how to do that (and I wanted this merged in) :)

@gregory.ashton no problem. I was also having a look at how to include a file in the README and it doesn't look like there's a straightforward solution.