Repository: bahir Updated Branches: refs/heads/master 61f5592e4 -> 48e91fca5
[BAHIR-36] Update Readme.md - Add how to build and test project Closes #12 Project: http://git-wip-us.apache.org/repos/asf/bahir/repo Commit: http://git-wip-us.apache.org/repos/asf/bahir/commit/48e91fca Tree: http://git-wip-us.apache.org/repos/asf/bahir/tree/48e91fca Diff: http://git-wip-us.apache.org/repos/asf/bahir/diff/48e91fca Branch: refs/heads/master Commit: 48e91fca54f7fab6f6171be4c05747a985876483 Parents: 61f5592 Author: Luciano Resende <[email protected]> Authored: Fri Jul 22 13:46:10 2016 -0700 Committer: Luciano Resende <[email protected]> Committed: Sat Jul 23 09:04:01 2016 -0700 ---------------------------------------------------------------------- README.md | 44 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bahir/blob/48e91fca/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 8cdbc5e..3513773 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ -# Bahir Repository +# Apache Bahir -Initial Bahir repository (see issue [BAHIR-1](https://issues.apache.org/jira/browse/BAHIR-1)) containing the source for the Spark streaming connectors for akka, mqtt, twitter, zeromq +Apache Bahir provides extensions to distributed analytics platforms such as Apache Spark. + +<http://bahir.apache.org/> + +## Apache Bahir origins + +The Initial Bahir source code (see issue [BAHIR-1](https://issues.apache.org/jira/browse/BAHIR-1)) containing the source for the Apache Spark streaming connectors for akka, mqtt, twitter, zeromq extracted from [Apache Spark revision 8301fad](https://github.com/apache/spark/tree/8301fadd8d269da11e72870b7a889596e3337839) (before the [deletion of the streaming connectors akka, mqtt, twitter, zeromq](https://issues.apache.org/jira/browse/SPARK-13843)). -This repo still needs license files, build scripts, READMEs, etc but it does have all of -the commit history as well as the respective examples (with rewritten revision trees to preserve pre-Bahir history). +## Source Code Structure - -Folder structure: +Source code folder structure: ``` - streaming-akka - examples/src/main/... @@ -19,3 +23,31 @@ Folder structure: - python - ... ``` + +## Building Bahir + +Bahir is built using [Apache Maven](http://maven.apache.org/). +To build Bahir and its example programs, run: + + mvn -DskipTests clean install + +## Running Tests + +Testing first requires [building Bahir](#building-bahir). Once Bahir is built, tests +can be run using: + + mvn test + +## Example Programs + +Each extension currently available in Apache Bahir has an example application located under the "examples" folder. + + +## Online Documentation + +Coming Soon. + + +## A Note About Apache Spark Integration + +Coming soon.
