You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by ju...@apache.org on 2015/05/09 03:42:11 UTC
incubator-reef git commit: update readme
Repository: incubator-reef
Updated Branches:
refs/heads/branch-0.11.0-incubating d29bdf522 -> b094cdc4b
update readme
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/b094cdc4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/b094cdc4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/b094cdc4
Branch: refs/heads/branch-0.11.0-incubating
Commit: b094cdc4b8846acc4c4755c7700bcb24f8b07df9
Parents: d29bdf5
Author: Julia Wang <jw...@yahoo.com>
Authored: Fri May 8 18:40:21 2015 -0700
Committer: Julia Wang <jw...@yahoo.com>
Committed: Fri May 8 18:40:21 2015 -0700
----------------------------------------------------------------------
README.md | 31 ++++++++++++++-----------------
1 file changed, 14 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/b094cdc4/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index e4e650d..42b2e01 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,28 @@
-# Apache REEF
+Apache REEF
+===========
-REEF (Retainable Evaluator Execution Framework) is a scale-out computing fabric
-that makes it easier to write Big Data applications on top of resource managers
-(e.g., Apache YARN and Mesos). For example, Azure Stream Analytics is built on
-REEF and Hadoop. Apache REEF is currently undergoing incubation at the [Apache
-Software Foundation](http://www.apache.org/).
+REEF (Retainable Evaluator Execution Framework) is a scale-out computing fabric that makes it easier to write Big Data applications on top of resource managers (e.g., Apache YARN and Mesos). For example, Azure Stream Analytics is built on REEF and Hadoop. Apache REEF is currently undergoing [incubation](http://reef.incubator.apache.org/) at the [Apache Software Foundation](http://www.apache.org/).
-<http://reef.incubator.apache.org/>
+Online Documentation
+--------------------
-## Online Documentation
+You can find the latest REEF documentation, including tutorials, on the [project web page](http://reef.incubator.apache.org/). This README file contains only basic setup instructions.
-You can find the latest REEF documentation, including tutorials, on the
-[project web page](http://reef.incubator.apache.org/). This README file
-contains only basic setup instructions.
-
-## Building REEF
+Building REEF
+-------------
Requirements
* Java 7 Development Kit
* [Apache Maven](http://maven.apache.org) 3 or newer. Make sure that mvn is in your PATH.
-* [Protocol Buffers](https://code.google.com/p/protobuf/) Compiler (protoc) 2.5. Make sure that protoc is in your PATH.
+* [Protocol Buffers](https://code.google.com/p/protobuf/) Compiler (protoc) 2.5. Make sure that `protoc` is in your PATH.
-REEF is built using Apache Maven.
-To build REEF and its example programs, run:
+Java REEF is built using Apache Maven. To build REEF and its example programs, run:
mvn -DskipTests clean install
+
+.Net REEF is build using msbuild, Which internally trigers the maven build for Java:
-More detailed documentation is available from the project site.
+ msbuild $REEFSourcePath\lang\cs\Org.Apache.REEF.sln /p:Configuration="Release" /p:Platform="x64"
+More detailed documentation is available from the [project wiki](https://cwiki.apache.org/confluence/display/REEF/Compiling+REEF)
\ No newline at end of file