{"action":"created","comment":{"url":"https://api.github.com/repos/apache/incubator-reef/pulls/comments/30285994","id":30285994,"diff_hunk":"@@ -1,31 +1,77 @@\n-# Apache REEF\n-\n-REEF (Retainable Evaluator Execution Framework) is a scale-out computing fabric\n-that makes it easier to write Big Data applications on top of resource managers\n-(e.g., Apache YARN and Mesos). For example, Azure Stream Analytics is built on\n-REEF and Hadoop. Apache REEF is currently undergoing incubation at the [Apache\n+Apache REEF (incubating)\n+========================\n+Apache REEF (Retainable Evaluator Execution Framework) is a scale-out\n+computing fabric that simplifies the development of Big Data\n+applications on top of resource managers (e.g., Apache YARN and\n+Mesos). For example, Azure Stream Analytics is built on REEF and\n+Hadoop. Apache REEF is currently undergoing incubation at the [Apache\n Software Foundation](http://www.apache.org/).\n \n-<http://reef.incubator.apache.org/>\n \n-## Online Documentation\n+Online Documentation\n+====================\n+This file will cover the very basics of compiling and testing\n+REEF. Much more detailed information can be found in the following\n+places:\n \n-You can find the latest REEF documentation, including tutorials, on the\n-[project web page](http://reef.incubator.apache.org/). This README file\n-contains only basic setup instructions.\n+  * [The project website](http://reef.incubator.apache.org/)\n+  * [The project wiki](https://cwiki.apache.org/confluence/display/REEF/Home)\n+  \n+[The developer\n+mailinglist](http://reef.incubator.apache.org/mailing-list.html) is\n+the best way to reach REEF's developers when the above aren't\n+sufficient.\n \n-## Building REEF\n+Building REEF\n+=============\n \n Requirements\n+------------\n \n-* Java 7 Development Kit\n-* [Apache Maven](http://maven.apache.org) 3 or newer. Make sure that mvn is in your PATH.\n-* [Protocol Buffers](https://code.google.com/p/protobuf/) Compiler (protoc) 2.5. Make sure that protoc is in your PATH.\n+  * Java 7 Development Kit\n+  * [Apache Maven](http://maven.apache.org) 3 or newer. Make sure that\n+    `mvn` is in your `PATH`.\n+  * [Protocol Buffers](https://code.google.com/p/protobuf/) Compiler\n+    version 2.5. Make sure that `protoc` is on your `PATH`.\n+  * For REEF.NET, you will also need [Visual Studio\n+    2013](http://www.visualstudio.com). Most REEF developers use the\n+    free Community Edition\n \n-REEF is built using Apache Maven.\n-To build REEF and its example programs, run:\n+REEF Java\n+---------\n+The Java side of REEF is built using Apache Maven. To build, execute:\n \n     mvn -DskipTests clean install\n \n-More detailed documentation is available from the project site.\n+To test, execute:\n+\n+    mvn test\n+\n+Note that the tests will take several minutes to complete. You will\n+also see stack traces fly by. Not to worry: Those are part of the\n+tests that test REEF's error reporting.\n+\n+REEF.NET\n+--------\n+REEF.NET uses REEF Java. In fact, the instructions below build REEF\n+Java as part of building REEF.NET. Hence, the same requirements apply.\n+\n+To build and test in Visual Studio, open\n+`lang\\cs\\Org.Apache.REEF.sln`.\n+\n+Alternatively, you can build REEF.NET from a developer command line\n+via:\n+\n+    msbuild .\\lang\\cs\\Org.Apache.REEF.sln\n+\n+To test, execute the following command thereafter:\n+\n+    vstest.console.exe .\\lang\\cs\\bin\\x64\\Debug\\Org.Apache.REEF.Tests\\Org.Apache.REEF.Tests.dll /Platform:x64\n \n+Additional Information\n+----------------------\n+More detailed documentation, including building from PowerShell and\n+creating NuGets is available from the [project\n+wiki](https://cwiki.apache.org/confluence/display/REEF/Home),\n+specifcially the [building\n+instructions](https://cwiki.apache.org/confluence/display/REEF/Compiling+REEF).","path":"README.md","position":95,"original_position":95,"commit_id":"877dcb187521f86b74fd0d8e9b6717960f0570cb","original_commit_id":"877dcb187521f86b74fd0d8e9b6717960f0570cb","user":{"login":"jwang98052","id":5666504,"avatar_url":"https://avatars.githubusercontent.com/u/5666504?v=3","gravatar_id":"","url":"https://api.github.com/users/jwang98052","html_url":"https://github.com/jwang98052","followers_url":"https://api.github.com/users/jwang98052/followers","following_url":"https://api.github.com/users/jwang98052/following{/other_user}","gists_url":"https://api.github.com/users/jwang98052/gists{/gist_id}","starred_url":"https://api.github.com/users/jwang98052/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jwang98052/subscriptions","organizations_url":"https://api.github.com/users/jwang98052/orgs","repos_url":"https://api.github.com/users/jwang98052/repos","events_url":"https://api.github.com/users/jwang98052/events{/privacy}","received_events_url":"https://api.github.com/users/jwang98052/received_events","type":"User","site_admin":false},"body":"\"building instruction\" shows as two lines in preview. ","created_at":"2015-05-13T23:22:49Z","updated_at":"2015-05-13T23:22:49Z","html_url":"https://github.com/apache/incubator-reef/pull/182#discussion_r30285994","pull_request_url":"https://api.github.com/repos/apache/incubator-reef/pulls/182","_links":{"self":{"href":"https://api.github.com/repos/apache/incubator-reef/pulls/comments/30285994"},"html":{"href":"https://github.com/apache/incubator-reef/pull/182#discussion_r30285994"},"pull_request":{"href":"https://api.github.com/repos/apache/incubator-reef/pulls/182"}}},"pull_request":{"url":"https://api.github.com/repos/apache/incubator-reef/pulls/182","id":35379726,"html_url":"https://github.com/apache/incubator-reef/pull/182","diff_url":"https://github.com/apache/incubator-reef/pull/182.diff","patch_url":"https://github.com/apache/incubator-reef/pull/182.patch","issue_url":"https://api.github.com/repos/apache/incubator-reef/issues/182","number":182,"state":"open","locked":false,"title":"[REEF-323] Update README.md with build instructions","user":{"login":"markusweimer","id":502371,"avatar_url":"https://avatars.githubusercontent.com/u/502371?v=3","gravatar_id":"","url":"https://api.github.com/users/markusweimer","html_url":"https://github.com/markusweimer","followers_url":"https://api.github.com/users/markusweimer/followers","following_url":"https://api.github.com/users/markusweimer/following{/other_user}","gists_url":"https://api.github.com/users/markusweimer/gists{/gist_id}","starred_url":"https://api.github.com/users/markusweimer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/markusweimer/subscriptions","organizations_url":"https://api.github.com/users/markusweimer/orgs","repos_url":"https://api.github.com/users/markusweimer/repos","events_url":"https://api.github.com/users/markusweimer/events{/privacy}","received_events_url":"https://api.github.com/users/markusweimer/received_events","type":"User","site_admin":false},"body":"JIRA:\r\n  [REEF-323](https://issues.apache.org/jira/browse/REEF-323)","created_at":"2015-05-13T23:01:47Z","updated_at":"2015-05-13T23:22:49Z","closed_at":null,"merged_at":null,"merge_commit_sha":"507bc5617d908faa96e0e620aa775e9a870d83bc","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/apache/incubator-reef/pulls/182/commits","review_comments_url":"https://api.github.com/repos/apache/incubator-reef/pulls/182/comments","review_comment_url":"https://api.github.com/repos/apache/incubator-reef/pulls/comments{/number}","comments_url":"https://api.github.com/repos/apache/incubator-reef/issues/182/comments","statuses_url":"https://api.github.com/repos/apache/incubator-reef/statuses/877dcb187521f86b74fd0d8e9b6717960f0570cb","head":{"label":"Microsoft-CISL:REEF-323","ref":"REEF-323","sha":"877dcb187521f86b74fd0d8e9b6717960f0570cb","user":{"login":"Microsoft-CISL","id":2067733,"avatar_url":"https://avatars.githubusercontent.com/u/2067733?v=3","gravatar_id":"","url":"https://api.github.com/users/Microsoft-CISL","html_url":"https://github.com/Microsoft-CISL","followers_url":"https://api.github.com/users/Microsoft-CISL/followers","following_url":"https://api.github.com/users/Microsoft-CISL/following{/other_user}","gists_url":"https://api.github.com/users/Microsoft-CISL/gists{/gist_id}","starred_url":"https://api.github.com/users/Microsoft-CISL/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Microsoft-CISL/subscriptions","organizations_url":"https://api.github.com/users/Microsoft-CISL/orgs","repos_url":"https://api.github.com/users/Microsoft-CISL/repos","events_url":"https://api.github.com/users/Microsoft-CISL/events{/privacy}","received_events_url":"https://api.github.com/users/Microsoft-CISL/received_events","type":"Organization","site_admin":false},"repo":{"id":30330372,"name":"incubator-reef","full_name":"Microsoft-CISL/incubator-reef","owner":{"login":"Microsoft-CISL","id":2067733,"avatar_url":"https://avatars.githubusercontent.com/u/2067733?v=3","gravatar_id":"","url":"https://api.github.com/users/Microsoft-CISL","html_url":"https://github.com/Microsoft-CISL","followers_url":"https://api.github.com/users/Microsoft-CISL/followers","following_url":"https://api.github.com/users/Microsoft-CISL/following{/other_user}","gists_url":"https://api.github.com/users/Microsoft-CISL/gists{/gist_id}","starred_url":"https://api.github.com/users/Microsoft-CISL/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Microsoft-CISL/subscriptions","organizations_url":"https://api.github.com/users/Microsoft-CISL/orgs","repos_url":"https://api.github.com/users/Microsoft-CISL/repos","events_url":"https://api.github.com/users/Microsoft-CISL/events{/privacy}","received_events_url":"https://api.github.com/users/Microsoft-CISL/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Microsoft-CISL/incubator-reef","description":"Mirror of Apache REEF (Incubating) for Pull Request staging","fork":true,"url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef","forks_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/forks","keys_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/teams","hooks_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/hooks","issue_events_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/issues/events{/number}","events_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/events","assignees_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/assignees{/user}","branches_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/branches{/branch}","tags_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/tags","blobs_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/git/refs{/sha}","trees_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/statuses/{sha}","languages_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/languages","stargazers_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/stargazers","contributors_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/contributors","subscribers_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/subscribers","subscription_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/subscription","commits_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/commits{/sha}","git_commits_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/git/commits{/sha}","comments_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/comments{/number}","issue_comment_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/issues/comments{/number}","contents_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/contents/{+path}","compare_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/merges","archive_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/downloads","issues_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/issues{/number}","pulls_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/pulls{/number}","milestones_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/milestones{/number}","notifications_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/labels{/name}","releases_url":"https://api.github.com/repos/Microsoft-CISL/incubator-reef/releases{/id}","created_at":"2015-02-05T01:06:12Z","updated_at":"2015-05-10T05:45:00Z","pushed_at":"2015-05-13T23:01:28Z","git_url":"git://github.com/Microsoft-CISL/incubator-reef.git","ssh_url":"git@github.com:Microsoft-CISL/incubator-reef.git","clone_url":"https://github.com/Microsoft-CISL/incubator-reef.git","svn_url":"https://github.com/Microsoft-CISL/incubator-reef","homepage":"","size":35406,"stargazers_count":2,"watchers_count":2,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":2,"default_branch":"master"}},"base":{"label":"apache:master","ref":"master","sha":"c1b7b0528cb00ce3c1a9b020efdf884a90f10d0d","user":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"repo":{"id":25623941,"name":"incubator-reef","full_name":"apache/incubator-reef","owner":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/apache/incubator-reef","description":"Mirror of Apache REEF (Incubating)","fork":false,"url":"https://api.github.com/repos/apache/incubator-reef","forks_url":"https://api.github.com/repos/apache/incubator-reef/forks","keys_url":"https://api.github.com/repos/apache/incubator-reef/keys{/key_id}","collaborators_url":"https://api.github.com/repos/apache/incubator-reef/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/apache/incubator-reef/teams","hooks_url":"https://api.github.com/repos/apache/incubator-reef/hooks","issue_events_url":"https://api.github.com/repos/apache/incubator-reef/issues/events{/number}","events_url":"https://api.github.com/repos/apache/incubator-reef/events","assignees_url":"https://api.github.com/repos/apache/incubator-reef/assignees{/user}","branches_url":"https://api.github.com/repos/apache/incubator-reef/branches{/branch}","tags_url":"https://api.github.com/repos/apache/incubator-reef/tags","blobs_url":"https://api.github.com/repos/apache/incubator-reef/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/apache/incubator-reef/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/apache/incubator-reef/git/refs{/sha}","trees_url":"https://api.github.com/repos/apache/incubator-reef/git/trees{/sha}","statuses_url":"https://api.github.com/repos/apache/incubator-reef/statuses/{sha}","languages_url":"https://api.github.com/repos/apache/incubator-reef/languages","stargazers_url":"https://api.github.com/repos/apache/incubator-reef/stargazers","contributors_url":"https://api.github.com/repos/apache/incubator-reef/contributors","subscribers_url":"https://api.github.com/repos/apache/incubator-reef/subscribers","subscription_url":"https://api.github.com/repos/apache/incubator-reef/subscription","commits_url":"https://api.github.com/repos/apache/incubator-reef/commits{/sha}","git_commits_url":"https://api.github.com/repos/apache/incubator-reef/git/commits{/sha}","comments_url":"https://api.github.com/repos/apache/incubator-reef/comments{/number}","issue_comment_url":"https://api.github.com/repos/apache/incubator-reef/issues/comments{/number}","contents_url":"https://api.github.com/repos/apache/incubator-reef/contents/{+path}","compare_url":"https://api.github.com/repos/apache/incubator-reef/compare/{base}...{head}","merges_url":"https://api.github.com/repos/apache/incubator-reef/merges","archive_url":"https://api.github.com/repos/apache/incubator-reef/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/apache/incubator-reef/downloads","issues_url":"https://api.github.com/repos/apache/incubator-reef/issues{/number}","pulls_url":"https://api.github.com/repos/apache/incubator-reef/pulls{/number}","milestones_url":"https://api.github.com/repos/apache/incubator-reef/milestones{/number}","notifications_url":"https://api.github.com/repos/apache/incubator-reef/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/apache/incubator-reef/labels{/name}","releases_url":"https://api.github.com/repos/apache/incubator-reef/releases{/id}","created_at":"2014-10-23T07:00:10Z","updated_at":"2015-05-08T20:12:14Z","pushed_at":"2015-05-13T23:01:47Z","git_url":"git://github.com/apache/incubator-reef.git","ssh_url":"git@github.com:apache/incubator-reef.git","clone_url":"https://github.com/apache/incubator-reef.git","svn_url":"https://github.com/apache/incubator-reef","homepage":null,"size":39853,"stargazers_count":15,"watchers_count":15,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":19,"mirror_url":"git://git.apache.org/incubator-reef.git","open_issues_count":5,"forks":19,"open_issues":5,"watchers":15,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/apache/incubator-reef/pulls/182"},"html":{"href":"https://github.com/apache/incubator-reef/pull/182"},"issue":{"href":"https://api.github.com/repos/apache/incubator-reef/issues/182"},"comments":{"href":"https://api.github.com/repos/apache/incubator-reef/issues/182/comments"},"review_comments":{"href":"https://api.github.com/repos/apache/incubator-reef/pulls/182/comments"},"review_comment":{"href":"https://api.github.com/repos/apache/incubator-reef/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/apache/incubator-reef/pulls/182/commits"},"statuses":{"href":"https://api.github.com/repos/apache/incubator-reef/statuses/877dcb187521f86b74fd0d8e9b6717960f0570cb"}}}}