Skip to content

Commit

Permalink
Improve README and developer experience (#1807)
Browse files Browse the repository at this point in the history
* Update VSCode configuration

* Lots of README changes

- 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

* Add a Content Security Policy

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
  • Loading branch information
CommandMC committed Sep 14, 2022
1 parent 2667bc3 commit 3f6541c
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 156 deletions.
22 changes: 5 additions & 17 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,14 @@
"version": "0.2.0",
"configurations": [
{
"command": "yarn react-start",
"name": "Start renderer process",
"request": "launch",
"type": "node-terminal"
},
{
"name": "Debug Main Process",
"type": "pwa-node",
"name": "Launch Heroic (HMR & HR)",
"type": "node",
"request": "launch",
"cwd": "${workspaceFolder}",
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
"runtimeExecutable": "${workspaceRoot}/node_modules/.bin/vite",
"windows": {
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
},
"resolveSourceMapLocations": [
"${workspaceFolder}/**",
"!**/node_modules/**"
],
"args": ["."],
"outputCapture": "std"
"runtimeExecutable": "${workspaceRoot}/node_modules/.bin/vite.cmd"
}
}
]
}
42 changes: 22 additions & 20 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,42 @@
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "dist",
"problemMatcher": [],
"label": "Test",
"type": "shell",
"label": "Run tests",
"command": "yarn test",
"detail": "yarn test",
"group": {
"kind": "test",
"isDefault": true
}
"group": "test"
},
{
"type": "npm",
"script": "dist",
"problemMatcher": [],
"type": "shell",
"label": "Build for Linux",
"detail": "yarn build-electron && yarn build && electron-builder -c.extraMetadata.main=build/main.js --linux",
"command": "yarn dist:linux",
"detail": "yarn dist:linux",
"group": {
"kind": "build",
"isDefault": true
}
},
{
"type": "npm",
"script": "dist",
"problemMatcher": [],
"type": "shell",
"label": "Build for Windows",
"detail": "yarn build-electron && yarn build && electron-builder -c.extraMetadata.main=build/main.js --win"
"command": "yarn dist:win",
"detail": "yarn dist:win",
"group": "build"
},
{
"type": "npm",
"script": "dist",
"problemMatcher": [],
"type": "shell",
"label": "Build for MacOS",
"detail": "yarn build-electron && yarn build && electron-builder -c.extraMetadata.main=build/main.js --darwin"
"command": "yarn dist:mac",
"detail": "yarn dist:mac",
"group": "build"
},
{
"type": "shell",
"label": "Check code for errors",
"command": "yarn codecheck",
"detail": "yarn codecheck",
"group": "test"
}
]
}

0 comments on commit 3f6541c

Please sign in to comment.