Improve README and developer experience #1807
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
- Update our bages; might've overdone it a little, but they're fun to add :^) - Add badges for Web Technologies used - Rewrite & bump up system requirements a bit - Wrap the Language list, Development in a container, and Screenshots in <details>; this makes the page load faster and makes it seem less daunting - Add a Flathub badge to the Flatpak section - Unify Linux install instructions (as much as possible) - Remove 3rd-party APT repository In my opinion, we have enough distribution formats already, and the install instructions are a little dodgy - Add Beta AUR package to the list - Clarify Windows install instructions by splitting up WinGet and manual install - Make "Development environment" its own section - Remove Beta and Alpha notes on Windows and macOS build instructions - Explain what exactly is happening when you run `yarn dev` and in which scenarios you might want to use it - Move the "Back to top" badge to the actual bottom of the page
This doesn't really do much in our situation: - Just in case someone ever manages to load a website in Heroic's main window, no JS can run inside it - Gets rid of the warning in the console when testing with `yarn dev` I've tested the Webviews (unaffected) and links to ProtonDB and such (also unaffected, not sure why though). Please test if this breaks anything
CommandMC
added
pr:testing
This also updates the Index & removes the 3rd party apt repository's install script
CommandMC
force-pushed
the
ref/readme
branch
from
c18ed3b
to
318bb9c
Compare
Nocccer
requested changes
Sep 12, 2022
Nocccer
approved these changes
Sep 12, 2022
|
The badges very rarely fail to load, that's true. Sadly can't do anything about that in the README, the user will just have to reload |
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.
This PR makes changes to the README (see commit about it for details), brings VSCode's configuration up to speed again, and resolves a warning (which wasn't an issue in our use case, but it's still nice to not see that every time you run
yarn devIMO)I've tested the Content Security Policy a bit (see notes on commit adding it) and it seems to not introduce any issues, but if you have some time, please verify this :^)
Use the following Checklist if you have changed something on the Backend or Frontend: