search

nf-core / tools

Python package with helper tools for the nf-core community.
https://nf-co.re
MIT License
241 stars 190 forks source link

Template: add option to exclude documentation from pipeline template #3130

Closed mirpedrol closed 2 months ago

mirpedrol commented 2 months ago

Part of https://github.com/nf-core/tools/issues/2340 and https://github.com/nf-core/tools/issues/2342

mirpedrol commented 2 months ago

The links in the readme are actually only nf-core (see here). But the documentation files could be added for non-nf-core pipelines too, no?

mashehu commented 2 months ago

imo readme should always be there, because that is git-best-practices. the other two files should be optional

mirpedrol commented 2 months ago

The pipeline readme is always there 🙂 here we are only removing the readme inside docs

mashehu commented 2 months ago

ah, was confused by the description. fixed that now

mirpedrol commented 2 months ago

thanks!