Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

Conversation

@stemangiola
Copy link
Member

Let me know what you think. I thought we were prioritising the wrong way on the readme.

@stemangiola stemangiola requested a review from mblue9 June 5, 2022 09:02
@mblue9
Copy link
Member

mblue9 commented Jun 5, 2022

We follow the template for the workshop here https://seandavi.github.io/BuildABiocWorkshop/articles/workshop_example.html
Although we should move the Installation and Syllabus down, not sure why we have them up top.
I think it's more usual to put Prerequisites after the Workshop Description paragraph so people can first see what the workshop topic is.
I don't know how strictly we're meant to stick to that template, could be good to stay close for consistency but if you feel strongly we could move stuff.

@stemangiola
Copy link
Member Author

We follow the template for the workshop here https://seandavi.github.io/BuildABiocWorkshop/articles/workshop_example.html

I see.

Although we should move the Installation and Syllabus down, not sure why we have them up top. I think it's more usual to put Prerequisites after the Workshop Description paragraph so people can first see what the workshop topic is.

Agree

I don't know how strictly we're meant to stick to that template, could be good to stay close for consistency but if you feel strongly we could move stuff.

I don't have strong opinions. I just thought that people should know the description and goals (what you learn and what not) before installing (with all technical details). Also because they don't put it in the Biocinductor description, and people on github README may just read the first few lines, for then complaining that the goals and pre-requisites were not clear :)

Anyway happy to keep it as it is, is not a big deal.

Copy link
Member

@mblue9 mblue9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add your changes, I think they make sense. The only thing I changed was moving the pre-requisites below the description.

@mblue9 mblue9 merged commit 6a3ea14 into master Jun 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants