Skip to content

Prepare for a public launch - #22

Merged
MehdiMamas merged 2 commits into
mainfrom
launch-readiness
Nov 10, 2026
Merged

MehdiMamas merged 2 commits into
mainfrom
launch-readiness

Conversation

@MehdiMamas

@MehdiMamas MehdiMamas commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner
  • README: one-line pitch first (same text as the repo description), a demo image under the banner, and exact download and install steps with the real installer file names.
  • docs/images/demo.png is the existing before/after illustration (Assets/Thumbnail.png); a recorded demo needs Windows and is not included.
  • .github/social-preview.png (1280x640). Uploading it needs Settings > Social preview in the web UI.
  • Issue templates (bug report, feature request, link to Discussions) and a PR template.
  • package.json now says SEE LICENSE IN LICENSE.txt, matching the MIT + Commons Clause file and the README.
  • Upstream credit is unchanged.

Part of #16. The translated READMEs (fr, it, ro, pl) use the same installer file names.

@MehdiMamas MehdiMamas linked an issue Nov 5, 2026 that may be closed by this pull request
@MehdiMamas

Copy link
Copy Markdown
Owner Author

Diff review:

  • .github/PULL_REQUEST_TEMPLATE.md:6 tells contributors to run pnpm build and pnpm test, but on main the project is still npm (src-tauri/tauri.conf.json:9-10, CONTRIBUTING.md:33, package-lock.json). Until Use pnpm instead of npm #17 merges the template is wrong, so merge Use pnpm instead of npm #17 first or use npm run build / npm test here.
  • docs/images/demo.png shows an older WinUI-style window (Home / Quick launch / Window rules sidebar), not the current Tauri UI. The caption says "Illustration", which is honest, but confirm it is fine to present this skin under the banner and that its authorship allows reuse.
  • README.md:1: the pitch line now sits above the # 🪟 HideMyWindows heading and the language bar. It renders, but the translated READMEs (README.fr.md, README.it.md, README.ro.md, README.pl.md) were not updated and still list HideMyWindows_x64-setup.exe-style names that do not exist on the release.

Checked and fine: installer names in README.md match the v2.3.3 assets, .github/social-preview.png is 1280x640, the licence wording in package.json and the README matches LICENSE.txt (MIT with Commons Clause), no install command is invented, and the issue template config links to the Discussions page.

Add the pitch as the first README line, a demo image, exact download and
install steps, a social preview image, issue templates and a PR template.
State the licence package.json refers to as LICENSE.txt.
@MehdiMamas

Copy link
Copy Markdown
Owner Author

Diff review:

  • README.md:1-3: the pitch line sits above the # 🪟 HideMyWindows heading and the language bar. It renders, but the page now opens with unstyled text before the title. Consider putting it directly under the heading, or confirm this is intended.
  • README.md:9: docs/images/demo.png (1919x1079) shows an older window design (Home / Quick launch / Window rules sidebar), not the current UI. The caption says "Illustration", which is honest, but a new visitor may expect the shipped look. Replace it with a real screenshot when one is available.
  • README.md:43-45: the <version> placeholder in the file names is correct for the v2.3.3 assets (HideMyWindows_2.3.3_x64-setup.exe etc.) and matches the translated READMEs. Not a problem; noted because the table cannot be copied verbatim.
  • README.md:47: ../../releases/latest is a relative link. It resolves on github.com but breaks if the README is rendered elsewhere (package page, mirrors). https://github.com/MehdiMamas/HideMyWindows/releases/latest is safer.

Checked and fine: package.json license wording matches LICENSE.txt (MIT with Commons Clause), the PR template's pnpm commands now match main (pnpm lockfile present), .github/social-preview.png is 1280x640, the README pitch equals the repo description, the issue template config links to Discussions, and upstream credit is unchanged.

@MehdiMamas
MehdiMamas merged commit 9673092 into main Nov 10, 2026
1 check passed
@MehdiMamas
MehdiMamas deleted the launch-readiness branch November 10, 2026 08:35
@MehdiMamas MehdiMamas mentioned this pull request Nov 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Launch readiness

1 participant