Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimum NF version to quick start section of main README #1032

Closed
drpatelh opened this issue Apr 22, 2021 · 5 comments · Fixed by #1064
Closed

Add minimum NF version to quick start section of main README #1032

drpatelh opened this issue Apr 22, 2021 · 5 comments · Fixed by #1064
Labels
documentation template nf-core pipeline/component template
Milestone

Comments

@drpatelh
Copy link
Member

The website currently trims off the badges off the top of the main README when rendered there. Given that this is currently the only place that the NF version is present in the README it would be good to add it somewhere else where it is quite visible.

e.g. as done here here

Will need to put this under bump versions control with nf-core/tools when updating the version of NF in the pipeline.

@drpatelh drpatelh added documentation template nf-core pipeline/component template labels Apr 22, 2021
@ewels ewels added this to the 1.14 milestone Apr 25, 2021
@KevinMenden
Copy link
Contributor

So if I understand that correctly, we just add the Nextflow version to the Quick Start section of the README.md in the template, and then modify bump-versions to take this into account, right?

@drpatelh
Copy link
Member Author

Yup. Exactly 👍🏽

@drpatelh
Copy link
Member Author

I have put something like this here so the NF version needs to be recognised there and bumped if required.

@KevinMenden
Copy link
Contributor

Alright, let's do that then, thanks! 👍

@KevinMenden KevinMenden linked a pull request May 10, 2021 that will close this issue
@ewels
Copy link
Member

ewels commented May 10, 2021

Done in #1064

@ewels ewels closed this as completed May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation template nf-core pipeline/component template
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants