Improve readme md file. Project: http://git-wip-us.apache.org/repos/asf/hama/repo Commit: http://git-wip-us.apache.org/repos/asf/hama/commit/6161c259 Tree: http://git-wip-us.apache.org/repos/asf/hama/tree/6161c259 Diff: http://git-wip-us.apache.org/repos/asf/hama/diff/6161c259
Branch: refs/heads/master Commit: 6161c2596188f8adcffc087206aa1dc089a35033 Parents: a33eadf Author: Edward J. Yoon <[email protected]> Authored: Tue Sep 22 13:40:14 2015 +0900 Committer: Edward J. Yoon <[email protected]> Committed: Tue Sep 22 13:40:14 2015 +0900 ---------------------------------------------------------------------- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hama/blob/6161c259/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e4ee925..fea4d49 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,20 @@ Apache Hama is a framework for Big Data analytics which uses the Bulk Synchronous Parallel (BSP) computing model, which was established in 2012 as a Top-Level Project of The Apache Software Foundation. -It provides not only pure BSP programming model but also SQL-like query interface (Apache MRQL) and vertex/neuron centric programming models, inspired by Google's Pregel and DistBelief (Apache Horn). For the latest information about Hama, please visit our website at: <https://hama.apache.org/> and our wiki, at: <https://wiki.apache.org/hama/> +It provides not only pure BSP programming model but also SQL-like query interface (Apache MRQL) and vertex/neuron centric programming models, inspired by Google's Pregel and DistBelief (Apache Horn). For the latest information about Hama, please visit our website at: <https://hama.apache.org/> and our wiki at: <https://wiki.apache.org/hama/> + +## Getting Started + +Please refer to the [Installation Guide](http://wiki.apache.org/hama/GettingStarted) in the online documentation for an overview on how to getting started with Hama. + +## Run Examples + +Hama provides examples package that allows you to quickly run examples on your Hama Cluster. To run one of them, use `% $HAMA_HOME/bin/hama jar hama-examples-x.x.x.jar`. For example: + +Download a [Iris dataset](http://people.apache.org/~edwardyoon/kmeans.txt). And then, run K-Means using: + +`% $HAMA_HOME/bin/hama jar hama-examples-x.x.x.jar kmeans /tmp/kmeans.txt /tmp/result 10 3` + +## Getting Involved + +Hama is an open source volunteer project under the Apache Software Foundation. We encourage you to learn about the project and contribute your expertise.
