From 720600a85d975f174123c46d29b0900ed42a8f27 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Thu, 16 Jul 2026 09:07:53 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=8E=20Showcase:=20Refined=20Quick=20St?= =?UTF-8?q?art=20and=20simplified=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ✨ Visuals: None 🔗 Links: Removed deployment guide link from local quick start ✂️ Trimmed: Summarized Quick Start section to focus entirely on running locally and reduced noise --- .jules/showcase.md | 1 + README.md | 9 ++------- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/.jules/showcase.md b/.jules/showcase.md index 4ead3eb5..db7ab57c 100644 --- a/.jules/showcase.md +++ b/.jules/showcase.md @@ -5,4 +5,5 @@ * **Missing Contributing Guide:** [RESOLVED] Users looking to contribute have no clear entry point. `CONTRIBUTING.md` has been enhanced with project structure and testing details. * **Deployment Info Clutter:** Deployment instructions were mixed with local run instructions, making the "Quick Start" hard to find. These have been moved to `docs/DEPLOYMENT.md`. * **Misleading Quick Start:** The `npm run dev` command implied it started the full stack, but the worker required a separate process. This led to "PENDING" simulation states for new users. +* **Deployment Info Clutter in Quick Start:** The Quick Start section previously included a link to the Deployment Guide which confused local development with server deployment. This has been removed to keep the focus strictly on running locally. diff --git a/README.md b/README.md index 144ee622..2826595e 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,9 @@ ## Quick Start -**Just want to run simulations?** Download the desktop worker for your platform from the [latest release](https://github.com/TytaniumDev/MagicBracketSimulator/releases/latest) and double-click. macOS builds are Developer-ID signed + notarized; Windows builds will trip SmartScreen the first time — click *More info → Run anyway*. The worker self-updates from then on. - -The worker has two modes: -- **Cloud:** signs in with Google, picks up jobs from the shared Firestore queue. Results show on the [web leaderboard](https://magic-bracket-simulator.web.app). -- **Offline:** picks 4 bundled Commander precons, runs the bracket locally, keeps results on your machine. - -**Want to run the whole stack locally for development?** See the [Deployment Guide](docs/DEPLOYMENT.md). The legacy Docker worker (`worker/`) is still in the repo and works, but the desktop worker (`worker_flutter/`) is the path going forward. +**Just want to run simulations?** Download the [latest desktop worker](https://github.com/TytaniumDev/MagicBracketSimulator/releases/latest) (macOS/Windows). The worker auto-updates and supports Cloud mode (Google sign-in) or Offline mode (local precons). +**Want to run the whole stack locally for development?** ```bash # Frontend + API npm run install:all && npm run dev