README: add screenshots and refresh the overview#202
Closed
jozef2svrcek wants to merge 1 commit into
Closed
Conversation
Add three app screenshots (game browser, opening tree, home screen) under docs/images/ and restructure the README around them: centered header with badges, a hero image, and a "Highlights" section pairing each screenshot with what that view is for. Also correct statements that no longer match the build: - The GUI is a pure HTTP client — no bundled sidecar (no externalBin), so the sidecar description and the dev:prepare-based dev instructions are replaced with "start chess-db serve, then npm run tauri dev" plus a short client/server architecture section. - Install section listing the actual release assets (three Linux .debs, Windows .exe, macOS .pkg); drop the .AppImage mention. - TWIC-only -> all three live reference sources, with their homepages and credits in Acknowledgements. - Mention the opening tree, position search, scheduled feed checks, automatic maintenance and LPDO_DATA_DIR. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Makes the public README more attractive and brings it back in line with the current build.
Screenshots
Three app screenshots added under
docs/images/:screenshot-games.png— hero image (player list, game list, board, score)screenshot-openings.png— opening tree with counts, score % and performancescreenshot-home.png— home screen: four entry points, database totals, latest source updateThe README is restructured around them: centered header with badges, hero image, and a Highlights section pairing each screenshot with what that view is for.
Accuracy fixes
The old text described a build that no longer exists, so rather than illustrating stale claims:
tauri.conf.jsonhas noexternalBin). The sidecar description and thedev:prepare-based dev instructions are replaced with "startchess-db serve, thennpm run tauri dev", plus a short client/server architecture section pointing atdocs/client-server-architecture.md..debs, Windows.exe, macOSaarch64.pkg), and the.AppImagemention is gone.LPDO_DATA_DIR.Note: the badges are served from shields.io, so they render on github.com but not offline.
🤖 Generated with Claude Code