Improve README documentation - #74
Open
wborn wants to merge 1 commit into
Open
Conversation
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.
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.
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:
ORLib,GenericApp, andprotobufmodulesThis 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.