A starter readme. #3
Conversation
|
|
||
| ## Citation | ||
|
|
||
| Please cite [xx.yyy/zenodo.zzzz](https://doi.org/xx.yyy/zenodo.zzzzz) for this work if you use this code. |
There was a problem hiding this comment.
this be in citation.cif instead, but let's do that later on
samcunliffe
force-pushed
the
start-readme
branch
2 times, most recently
from
2d0ccc8
to
3678ac2
Compare
| [pypi-platforms]: https://img.shields.io/pypi/pyversions/{{cookiecutter.project_slug}} | ||
| [pypi-version]: https://img.shields.io/pypi/v/{{cookiecutter.project_slug}} | ||
| [rtd-badge]: https://readthedocs.org/projects/{{cookiecutter.project_name}}/badge/?version=latest | ||
| [rtd-link]: https://{{cookiecutter.project_slug}}.readthedocs.io/en/latest/?badge=latest |
There was a problem hiding this comment.
A question: should we keep all of this? We don't really recommend RTD over github pages so feels like we shouldn't make a choice here, but leave it to the user.
But then our cookie-cutter becomes very complicated: should we have "are you using GH discussions or slack?" and "are you using github pages or RTD?" type questions? Or just leave a lot of this commented out for the user to uncomment further down the line.
There was a problem hiding this comment.
It would definitely be nicer to offer the option of github pabes vs rtd, but probably in a separate pr. Maybe remove the links for now?
And the PyPI badges could probably just be commented out and a comment added that says to uncomment once the package has been published
There was a problem hiding this comment.
Yeah agreed. Let's put that onto
|
Your badges got eaten, sorry Paul. |
Based on the Newcastle RSE groups project template
with some totally untested cookiecutter fields.