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

docs: richer README #2

Open
3 tasks
tiborsimko opened this issue Jan 22, 2020 · 0 comments
Open
3 tasks

docs: richer README #2

tiborsimko opened this issue Jan 22, 2020 · 0 comments

Comments

@tiborsimko
Copy link
Member

tiborsimko commented Jan 22, 2020

Let's enrich README to resemble other existing REANA examples such as:

This comprises several things:

  • Explain astronomy behind the example to casual visitors: can be as brief or as detailed as deemed necessary. @volodymyrss Can you take care of that?

  • Amend the REANA.rst structure following usual examples. This is just cosmetics, we could take it separately once the astronomy content is clear.

  • The workflow produces two figures, good_fit_png_content.png and next_good_fit_png_content.png. Save them into docs/... folder so that people can compare. Use them in README for graphical appeal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant