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

neat-picks on README #1128

Merged
merged 2 commits into from
Dec 5, 2019
Merged

neat-picks on README #1128

merged 2 commits into from
Dec 5, 2019

Conversation

KtorZ
Copy link
Member

@KtorZ KtorZ commented Dec 5, 2019

Issue Number

N/A

Overview

  • Remove coverall badge until we restore it
  • Add a section 'how to install'
  • Point 'how to build' to the wiki
  • Rename 'compatibility matrix' to 'latest releases' and nest it
    under 'how to install'

Comments

- Remove coverall badge until we restore it
- Add a section 'how to install'
- Point 'how to build' to the wiki
- Rename 'compatibility matrix' to 'latest releases' and nest it
  under 'how to install'
@KtorZ KtorZ requested a review from piotr-iohk December 5, 2019 17:49
@KtorZ KtorZ self-assigned this Dec 5, 2019
README.md Outdated Show resolved Hide resolved
Co-Authored-By: anviking <johannes.lund@iohk.io>
Copy link
Member

@Anviking Anviking left a comment

Choose a reason for hiding this comment

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

💯


> ### Latest releases
>
> | cardano-wallet | Jörmungandr |
Copy link
Member

@Anviking Anviking Dec 5, 2019

Choose a reason for hiding this comment

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

What if the table header Jörmungandr was supported Jörmungandr to highlight the relationship between the two?

Copy link
Member

@Anviking Anviking Dec 5, 2019

Choose a reason for hiding this comment

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

Additionally it might be worth a sentence in "Overview" explaining what Jörmungandr is.

(Imagining people landing here randomly might be unclear about what jormungandr is, and maybe people coming here for the testnet could be confused by the current generic overview which doesn't mention the testnet or jormungandr)

Copy link
Member Author

Choose a reason for hiding this comment

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

You have a point! I am only seeing your comment now though :(

@KtorZ KtorZ merged commit 8961eb6 into master Dec 5, 2019
@KtorZ KtorZ deleted the KtorZ/README-neat-picks branch December 5, 2019 18:26
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.

2 participants