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

Adding README.adoc file #1

Merged
merged 1 commit into from
Sep 16, 2022
Merged

Adding README.adoc file #1

merged 1 commit into from
Sep 16, 2022

Conversation

kasturinarra
Copy link
Contributor

Adding a README.adoc file as per rh-impact/pnt-hackathon-2022#41 @porridge could you please help merge ? thanks !!

@porridge
Copy link
Collaborator

I have a couple of questions @kasturinarra

  • there already is a README.md in this directory, so having two READMEs side by side could be confusing
  • I'm not sure how useful it is to document all the options for the optipng binary right now, if the only way to use them is via interactive container execution (which I understand is not something feasible for a typical ChRIS user).

@kasturinarra
Copy link
Contributor Author

I have a couple of questions @kasturinarra

  • there already is a README.md in this directory, so having two READMEs side by side could be confusing
    I am not sure why such a task was added then in the first place if we were not supposed to have two README files , also when i checked others repo's i do see we are having README.adoc as well, so added one. For example see here https://github.com/rh-impact/pl-deoldify/pull/3/files
  • I'm not sure how useful it is to document all the options for the optipng binary right now, if the only way to use them is via interactive container execution (which I understand is not something feasible for a typical ChRIS user).
    I did mention both the ways, interactive and non-interactive.

@kasturinarra
Copy link
Contributor Author

@porridge that being said if you think this does not make sense, i am okay to close this, thanks !!

@kasturinarra
Copy link
Contributor Author

@porridge i spoke to @computate and based on his suggestions i have removed the README.adoc file and added some content into the README.rst which is present here. Would you mind taking a look and see if you could merge ? thanks !!

@computate computate self-requested a review September 16, 2022 19:17
@computate computate merged commit 7c166a6 into rh-impact:main Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants