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

Update README.md to add missing Requirements section #114

Merged
merged 2 commits into from Feb 27, 2017
Merged

Update README.md to add missing Requirements section #114

merged 2 commits into from Feb 27, 2017

Conversation

manez
Copy link
Member

@manez manez commented Feb 23, 2017

What does this Pull Request do?

Adds the missing Requirements section to bring it in line with the readme template. Took verbiage from the wiki: https://wiki.duraspace.org/display/ISLANDORA/Compound+Solution+Pack

How should this be tested?

Have a look at the changes, verify the links work and that these are the actual requirements. Check against readme template.

Interested parties

@DiegoPino or maintainer @whikloj

Add missing Requirements section.
@manez manez changed the title Update README.md Update README.md to add missing Requirements section Feb 23, 2017
@DiegoPino
Copy link

@manez will merge when Travis passes. thanks

README.md Outdated
This module requires the following modules/libraries:

* [Islandora](https://github.com/islandora/islandora)
* [JAIL](https://github.com/sebarmeli/JAIL) library

Choose a reason for hiding this comment

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

Forgot about this for the committers call, but I guess any other @Islandora/7-x-1-x-committers could help with this. JAIL is documented as a requirement but the module itself does not impose it as a requirement (only needed if enabled in the block). I personally vote for consistency across our docs but would also make sure people don't have to install libraries they won't be using. Any thoughts?

@rosiel
Copy link
Member

rosiel commented Feb 24, 2017

at this point I am for including a list of conditional requirements after the requirements and explain which functionality it is a requirement for.

@manez
Copy link
Member Author

manez commented Feb 24, 2017

How about:

Requirements

This module requires the following modules/libraries:

This module has the following as optional requirements for certain features:

For Islandora Compound Object JAIL Display:

@DiegoPino
Copy link

DiegoPino commented Feb 27, 2017

@manez there seems to be agreement on the wording, feel free to update whenever you want and will merge. Thanks!

@manez
Copy link
Member Author

manez commented Feb 27, 2017

@DiegoPino updated with the new wording!

@DiegoPino DiegoPino merged commit 178fc1d into Islandora:7.x Feb 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants