Skip to content

Improve README documentation - #74

Open
wborn wants to merge 1 commit into
mainfrom
improve-readme
Open

Improve README documentation#74
wborn wants to merge 1 commit into
mainfrom
improve-readme

Conversation

@wborn

Copy link
Copy Markdown
Member

Summary

Improve the repository README so it gives a clearer overview of what the Android console project provides and how the different modules are used.

The updated README:

  • explains the role of the Android console within OpenRemote
  • documents the ORLib, GenericApp, and protobuf modules
  • links to the Android app on Google Play
  • links to the published Maven Central artifacts
  • links to the equivalent iOS app and library projects
  • adds relevant OpenRemote documentation links
  • documents the basic build and Spotless formatting commands
  • adds licensing information

This should make the repository more useful both for users looking for the mobile app and for developers wanting to build or integrate the Android console.

Expand the README with an overview of the Android console, repository structure, published artifacts, mobile app links, related iOS projects, development commands, and relevant OpenRemote documentation.
@wborn
wborn requested a review from a teamAugust 28, 2026 10:06
@wbornwborn added the Documentation Improvements or additions to documentation label Aug 28, 2026
@wbornwborn self-assigned this Aug 28, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DocumentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@wborn