-
-
Notifications
You must be signed in to change notification settings - Fork 204
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 README. #1089
Update README. #1089
Conversation
Good call, the README has become quite cluttered. Some comments:
|
I'll be honest, I got the idea for the top section from browsing to other GitHub pages. I really liked the way the Helix README looked, so I got (a lot of) inspiration from their README. One problem with this README is that the icon doesn't show on the GitHub app, as there seems to be a bit of a problem there with parsing the HTML for switching out the icons. It just shows the alt text. A solution could be to use a gray-ish color for the text and not to use the switching behavior for light/dark.
I didn't think about that. I thought it would be good for packagers to know which platforms already have a package available, but indeed it also makes a lot of sense in the installation instructions. Like I mentioned I didn't spend much time on the subcategories yet so there is still a bit of work left there (reordering things, moving/copying things between them...).
I split them because linking to another file on GitHub doesn't take sections into account (developers.md#section), that only works for the page you're currently on. So for a packager, they would click 'more info' in the main README and it would take them to the top of |
I added the package information to the user installation instructions and also did some other small changes to make sure everything is up to date and correct. Most of the configuration section is just copied over to Regarding the packaging section, I considered adding it to the The version of the packaging page should now give all/only the commands required to build a package, while the development page provides all/only the information to develop ncspot. If this approach isn't ok, I'll happily move the packaging stuff over to the development page 🙂 |
Merged! The reason I thought they could go together is because for instance the feature flags may be relevant for packagers, but since there is a link that also works. Thanks a lot for cleaning up the docs! |
@ThomasFrans sorry for the bump, do you remember what font is used in the main screenshot? I couldn't find it in the README nor here. Edit: I was just skimming through nerd-fonts and looks like Iosevka, but not 100% sure |
@jonathannerat I don't know what font it is. I just copied the screenshot when changing the README as I didn't want to change the actual content too much. |
This is just an example of the change I proposed in #1061. I'm not an artist and my creative skills are about as good as a toddler (maybe even worse). This is just an attempt to show what I meant by shrinking the main README and providing information for users, developers and packagers separately. Therefore the 'subpages' aren't finished yet. I wanted to focus on the main README and ask input first.
Some things I tried to do: