docs: modern README with logo, badges, screenshots + Apache-2.0 license#18
Merged
Conversation
Rework README.md into a proper landing page: centered logo (the brand-green app icon), status badges (CI, latest release, .NET 10, platforms), a features overview, a Screenshots section (Mobile/Tablet/Web), and clearer Install (Android via Obtainium + Web), Build-from-source, Architecture, Tech stack, Contributing, License and Acknowledgements sections. Documents the Web head and the Data project, which the old layout table omitted. Screenshot images are wired up under .github/assets/ and will be added next. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHCRc5CJ6595iMzEgYYdQp
Add the Apache License 2.0 and point the README's License section (and a new license badge) at it, replacing the earlier "all rights reserved / TBD" note. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHCRc5CJ6595iMzEgYYdQp
Capture the session view (Convergence welcome screen) at phone, tablet and desktop viewports for the Screenshots section, and reflow the prose paragraphs to one line each (no mid-sentence hard wraps). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HHCRc5CJ6595iMzEgYYdQp
There was a problem hiding this comment.
Pull request overview
This PR modernizes the repository’s top-level documentation by turning README.md into a more complete landing page (branding, badges, screenshots, install/build/architecture sections) and adds an Apache-2.0 LICENSE file so the project’s licensing is explicit and linkable from the README.
Changes:
- Reworked
README.mdstructure and content (branding header, badges, features, screenshots, install/build-from-source guidance, architecture/tech stack, contributing, license, acknowledgements). - Added Apache License 2.0 text as
LICENSEand linked to it from the README/badge.
Reviewed changes
Copilot reviewed 2 out of 6 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Rewritten as a polished landing page with badges, screenshots, and expanded install/build/architecture content. |
| LICENSE | Adds Apache License 2.0 file for repository licensing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+2
|
|
||
| Apache License |
| ## Build from source | ||
|
|
||
| ## Building & testing | ||
| The day-to-day loop needs no Android SDK — it runs on the `Core`, `Data` and `UI` projects and the test suites: |
| ```sh | ||
| # Core + UI + Tests (no Android SDK required) | ||
| dotnet build SharpClient.slnx # note: excludes the App head if it can't build | ||
| dotnet build SharpClient.slnx # solution (skips the App head if it can't build) |
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
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.
Reworks
README.mdinto a proper landing page, and adds a license.README
dotnet runpath), Build from source, Architecture (now includes theWebandDataprojects the old table omitted), Tech stack, Contributing, License, AcknowledgementsLicense
LICENSE) and points the README + badge at it.Assets
.github/assets/logo.png— brand mark.github/assets/screenshot-{mobile,tablet,web}.pngNo source/csproj changes, so this is independent of the TNC-bump PRs.
🤖 Generated with Claude Code