search

BioContainers / specs

BioContainers specifications
http://biocontainers.pro
Apache License 2.0
49 stars 12 forks source link

removing CMD examples from Dockerfile header #67

Closed prvst closed 7 years ago

prvst commented 7 years ago

I think we should remove the CMD examples from the header metadata. Some software have complex commands, and we can't list all of them. Also, I don't think this qualifies as metadata.

ypriverol commented 7 years ago

I agree. Howwer we need to specify a simple command where the user can start. It can be a README page where the user can see how to run the container.

prvst commented 7 years ago

we can add a readme file to the repository and dockerhub pages, both can contain examples. We can also use our wiki for that

On Thu, Oct 6, 2016 at 11:56 AM Yasset Perez-Riverol < notifications@github.com> wrote:

I agree. Howwer we need to specify a simple command where the user can start. It can be a README page where the user can see how to run the container.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/BioContainers/specs/issues/67#issuecomment-252006564, or mute the thread https://github.com/notifications/unsubscribe-auth/AAYo-YMJKXuPbtjRIndHxVFc75rYycr6ks5qxRopgaJpZM4KQG_F .

ypriverol commented 7 years ago

For now less remove this from the metadata tag. Can we specify for all how to run the test for example the --version that we have been discussing in testing.

prvst commented 7 years ago

yes, we can add another option like ' --explain' or whatever, that will print some examples and/or expose some of the metadata information

On Thu, Oct 6, 2016 at 12:02 PM Yasset Perez-Riverol < notifications@github.com> wrote:

For now less remove this from the metadata tag. Can we specify for all how to run the test for example the --version that we have been discussing in testing.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/BioContainers/specs/issues/67#issuecomment-252008253, or mute the thread https://github.com/notifications/unsubscribe-auth/AAYo-R6AKsg6qL1VHIhOsbVOWH5Knl49ks5qxRt9gaJpZM4KQG_F .

ypriverol commented 7 years ago

@prvst with the current specification a simple page to the documentation ( #68 ) is enough. I will close this issue.