-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Update the readme #793
Update the readme #793
Conversation
I feel that the troubleshooting section should remain on the wiki so it's easier to edit (no need to create PRs). Not sure how to give a link to it enough exposure in the readme though. Perhaps also add a link to the FAQ? |
|
||
<div align="center" style="display:inline"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't particularly like the screenshots, they don't use the default theme and the shine distracts away from the editor. We should show it as it looks out of the box. (I think the current screenshot looks "nice" enough but that's because I like my bitnap fonts)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand not liking the acyclic, but I think using a theme that is appealing to the majority would help with first impressions(if you care). The Onedark theme is included and seems like a more popular choice.
It's seem like you want to show off features rather than looks, which is hard to do in a screenshot, maybe a few gifs would be a better choice? Like what onivim has on their website.
Up to you really, can change it back if you want.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using a theme that is appealing to the majority would help with first impressions
I think this a very subjective thing. Editors are usually presented as they are out of the box, and given that I've written both the editor and the theme, that's the theme that's default. See Kakoune for very plain screenshots that do a great job of showcasing basic features.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this a very subjective thing.
Whether a theme is good or not is subjective, however the popularity of a theme is not. One dark for example, has almost 7 million downloads on vscode, there is atleast something quantifiable about that.
As for Kakoune, it looks at least 30 years out of date(the gifs are okay). Which is frustrating because I'm sure the features are good. There's no need to compromise like that, you can have both functionality and aesthetics. Again onivim manages to do this well.
|
||
# Features | ||
## ✨ Features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd drop the emoji too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All of them or just the one?
Co-authored-by: Blaž Hrastnik <[email protected]>
Co-authored-by: Blaž Hrastnik <[email protected]>
The screenshot is hard to read, the translucent background reduces the contrast and hurt my eyes reading it. Is it possible to have an opaque background to be clearer? |
Yes, I doubt they will be the final screenshots. Also, here's a more moderate opacity of 85%. |
Maybe something for docs/vision.md as well? |
Yes, that is readable. But not sure why top left part looks weird, it have a reddish rectangle. |
A few tweaks to the readme.
I initially had some trouble setting up helix(installing from source). I wanted to clarify the runtime section because it's not required for most platforms.
Some of the changes won't be everyones taste, so I'd like to hear your thoughts on it. I feel like the acylic might be a little too much? Screenshots not tall enough? More purple?
Oh yeah, I was wondering if you need to setup the runtime when installing with homebrew. I'll need to add that to the readme.
If you want to see a live preview.