Repository: incubator-wave Updated Branches: refs/heads/wavy ac0393d91 -> a53e35d08
Add more info to the main readme and comment the main BUILD file. Project: http://git-wip-us.apache.org/repos/asf/incubator-wave/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave/commit/a53e35d0 Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave/tree/a53e35d0 Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave/diff/a53e35d0 Branch: refs/heads/wavy Commit: a53e35d086951d4b5ebbfaf3fcb38ce6f0dcb0c2 Parents: ac0393d Author: wisebaldone <[email protected]> Authored: Thu Apr 28 12:06:50 2016 +1000 Committer: wisebaldone <[email protected]> Committed: Thu Apr 28 12:06:50 2016 +1000 ---------------------------------------------------------------------- BUILD | 5 ++++- README.md | 45 ++++++++++++++++++++++++++++++++++++++------- 2 files changed, 42 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/a53e35d0/BUILD ---------------------------------------------------------------------- diff --git a/BUILD b/BUILD index cd450ac..8af20a7 100644 --- a/BUILD +++ b/BUILD @@ -1,4 +1,7 @@ # Sets the Golang root dir. load("@io_bazel_rules_go//go:def.bzl", "go_prefix") - go_prefix("server") + + +# Global Tasks +# - Include tasks to create distributions http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/a53e35d0/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 1877b1b..03604dc 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,16 @@ | --- | --- | | Travis | [](https://travis-ci.org/apache/incubator-wave) | -The Apache Wave project is a stand alone wave server and rich web editor and -multiple platform clients that serves as a Wave reference implementation. +The Apache Wave project is a stand alone wave server and client that serves as +a Wave reference implementation. The project also includes a rich text editor +and clients for web, android and ios. 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 through federation. +## About + The Apache Wave project is a distributed, near-real-time, rich collaboration platform that allows users to work together in new and exciting ways. Wave allows for flexible modes of communication, blending chat, email and @@ -32,18 +35,46 @@ collaboration between users. ## Documentation +To read the current Documentation please visit [todo(wisebaldone): replace with +url when website published] or optionally build the website to view locally ( +see website sub project folder ). + ## Getting started +The following information is needed for setting up a development environment for +the Apache Wave project. If you are looking for information about using the +built distributions of the project please see +[here](https://incubator.apache.org/wave). + ### Requirements -For dev requirements please see the individual projects. +To build the project each individual sub project lists its own requirments and +can be built individually. + +To use the build tool Bazel will need to be installed, [guide here](http://bazel.io/docs/install.html). +It is recommended to be using a Unix platform than a windows platform, though +using the Ubuntu on windows 10 feature could possibly be an alternative. -For release requirments please see the list below: +Please note that the project aims to be multiplatform and is designed to be able +to run on any modern platform though the tools used restrict which platforms +builds can happen. -#### Server +### Building from source -#### Client + git clone https://git-wip-us.apache.org/repos/asf/incubator-wave.git + cd incubator-wave + git checkout wavy + bazel build //server:server -#### Editor +Note: to only build individual projects please see the sub project readme's + +todo(wisebaldone): replace with bazel command to create distributions. ## Contributing + +To contirbute to Apache Wave please goto +https://incubator.apache.org/wave/get-involved.html where youll be able to find +information about how to participate. + +The project is always looking for people from designers to coders in a variety +of programming languages and spoken languages.
