Simplify introduction on README #789
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there). Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project. Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description.
astorije
added
Type: Documentation
|
We can improve the intro a bit now or more later, but moving away from the current layout, pretty much a 1:1 copy of Shout's README, is a good thing IMO. |
|
IMO, readme should list a couple of features (doesn't have to be an actual list). |
|
Fine by me (that's what I meant in my previous comment): which ones would you see there? |
AlMcKinlay
approved these changes
Dec 12, 2016
There was a problem hiding this comment.
Honestly, I'm not really sure what features we would write that it doesn't already show in the screenshot. I'm happy with this. If @xPaw wants a couple of things added, then I'm also fine with that.
matburnham
pushed a commit
to matburnham/lounge
that referenced
this pull request
Sep 6, 2017
…me-intro Simplify introduction on README
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there).
Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project.
Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description.