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.

Sign up for GitHub

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

Jump to bottom

added high level overview to readme #178

Merged
merged 2 commits into from
Feb 1, 2022
Merged

added high level overview to readme #178

merged 2 commits into from
Feb 1, 2022

Conversation

egpbos
Copy link
Member

@egpbos egpbos commented Jan 31, 2022

Fixes #137

@egpbos egpbos requested review from elboyran and loostrum January 31, 2022 15:53
@egpbos egpbos force-pushed the 137_high_level_summary branch from 763b0c0 to f74e2d1 Compare January 31, 2022 15:54
@elboyran
Copy link
Contributor

Some checks are not passing, is it ready for review?

@egpbos egpbos mentioned this pull request Jan 31, 2022
Merged
@cwmeijer
Copy link
Member

cwmeijer commented Jan 31, 2022 •
edited
Loading

Strange, the links that the markdown-link-check is complaining about works fine now. I'll restart the checks.
...
Now they pass :-)

loostrum
loostrum approved these changes Feb 1, 2022
View reviewed changes
Copy link
Member

@loostrum loostrum left a comment

Choose a reason for hiding this comment

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

I like it! Short and to the point, which is great for potential users

elboyran
elboyran requested changes Feb 1, 2022
View reviewed changes
Copy link
Contributor

@elboyran elboyran left a comment •
edited
Loading

Choose a reason for hiding this comment

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

As you noticed already, it now overlaps with what's under Why DIANNA below (after merging #177). I propose we leave one sentence (merging first and last bullet points as I didn't mention them in #177) and add informative image possibly with 1 sentence.
I've edited it in the branch.

@egpbos egpbos merged commit e2581af into main Feb 1, 2022
@elboyran elboyran deleted the 137_high_level_summary branch February 4, 2022 15:25
@elboyran elboyran restored the 137_high_level_summary branch February 4, 2022 15:25
@elboyran elboyran deleted the 137_high_level_summary branch February 4, 2022 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elboyran elboyran elboyran approved these changes

@loostrum loostrum loostrum approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

readme(/JOSS): add high-level summary
4 participants
@egpbos @elboyran @cwmeijer @loostrum