Update readme with building information
Project: http://git-wip-us.apache.org/repos/asf/incubator-wave-android/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave-android/commit/2f2c2aca Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave-android/tree/2f2c2aca Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave-android/diff/2f2c2aca Branch: refs/heads/master Commit: 2f2c2acad97f3f746f2020d64055bf46fa61cf2e Parents: 514564b Author: Ali Lown <[email protected]> Authored: Sat Sep 26 12:22:16 2015 +0100 Committer: Ali Lown <[email protected]> Committed: Sat Sep 26 12:22:16 2015 +0100 ---------------------------------------------------------------------- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave-android/blob/2f2c2aca/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index b40ef83..5b2ab4a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,31 @@ -# Apache Wave Client for Android +Apache Wave Client for Android +------------------------------- "Wave in a Box" (WIAB) project is a stand alone wave server and rich web client that serves as an Apache Wave reference implementation. Apache Wave site: http://incubator.apache.org/wave/ This project lets developers and enterprise users run wave servers and host waves on their own hardware. And then share those waves with other wave servers. + +Build +----- + +The Android client requires Java 7, and an Android device running Android 5.0 or higher. + +The client can be built using gradle, from the command line, or via an IDE (IDEA files can be found in this repository). + +You will need to install the Android SDK first, the latest version can always be found at https://developer.android.com/sdk/index.html. + +To build everything, run: + gradle assemble + +To run the tests, run: + gradle check + +A full list of gradle tasks can be found by running: + gradle tasks + +To learn more about Wave and the Wave Protocols: +------ +1. Subscribe to the wave-dev mailing list, find instructions at http://incubator.apache.org/wave/mailing-lists.html. +2. Take a look at the developer docs at https://incubator.apaceh.org/wave/documentation.html +3. Visit the Apache Wave wiki at https://cwiki.apache.org/confluence/display/WAVE/Home. +
