{"action":"created","comment":{"url":"https://api.github.com/repos/ysshao/ALADDIN/pulls/comments/43582084","id":43582084,"diff_hunk":"@@ -82,7 +84,210 @@ Requirements:\n        ```\n \n Build:\n-------\n+-----------------\n+  Aladdin currently supports two ways to build.\n+\n+  1. Configure with CMake, then build with Make :\n+\n+       If you are familiar with CMake, or you are interested in a script\n+       which can build out-of-source and offer automatical LLVM/Clang\n+       installation, choose [CMake](#build-with-cmake)\n+\n+  2. Directly build with Makefile :\n+\n+       If you want to keep all the things simple, or you do not have\n+       CMake, choose [Makefile](#build-with-makefile)\n+\n+\n+Build with CMake:\n+-----------------\n+CMake is a configure tool which allows you to out-of-source build.\n+Aladdin Requires CMake newer than 2.8.12. By default, CMake\n+searches for LLVM 3.4.\n+\n+\n+1. Set `$BOOST_ROOT`,  `TRACER_HOME`, `LLVM_HOME` to let Aladdin know where the tools and libraries are.\n+\n+   ```\n+   export BOOST_ROOT=/your/path/to/boost\n+   export TRACER_HOME=/your/path/to/LLVM-Tracer\n+   export LLVM_HOME=/your/path/to/llvm\n+   ```\n+\n+2. Use CMake to configure Aladdin and build libraries and executables\n+\n+   ```\n+   mkdir /where/you/want/to/put/your/binary\n+   cd /where/you/want/to/put/your/binary\n+   cmake /your/path/to/Aladdin\n+   make -j4\n+   ```\n+\n+3. (Optional) Run tests with `ctest` command\n+\n+   **CAUTION : Takes a long time**\n+\n+   **Suggest running part of them, like `\"triad\"` or `\"unit_test\"`.**\n+\n+   There are 1397 tests. On Intel Xeon E5-2650 2.60GHz,\n+   execution in 32 jobs takes 39 minutes,\n+   and execution in sequential takes 6.5 hours.\n+\n+\n+   Runs all the tests in sequential.\n+   ```\n+   ctest\n+   ```\n+\n+   Runs all the tests in parallel. You can mix this option with test\n+   filtering option to speed up tests.\n+   ```\n+   ctest -j JOB_NUM","path":"README.md","position":72,"original_position":72,"commit_id":"2fd83c340db11f1111faae05bb305560437fde93","original_commit_id":"2fd83c340db11f1111faae05bb305560437fde93","user":{"login":"rgly","id":11572209,"avatar_url":"https://avatars.githubusercontent.com/u/11572209?v=3","gravatar_id":"","url":"https://api.github.com/users/rgly","html_url":"https://github.com/rgly","followers_url":"https://api.github.com/users/rgly/followers","following_url":"https://api.github.com/users/rgly/following{/other_user}","gists_url":"https://api.github.com/users/rgly/gists{/gist_id}","starred_url":"https://api.github.com/users/rgly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rgly/subscriptions","organizations_url":"https://api.github.com/users/rgly/orgs","repos_url":"https://api.github.com/users/rgly/repos","events_url":"https://api.github.com/users/rgly/events{/privacy}","received_events_url":"https://api.github.com/users/rgly/received_events","type":"User","site_admin":false},"body":"I added the following explaination to readme. After `filtering option to speed up tests.`\r\n```\r\nThe JOB_NUM here means the max job number to run simultaneously. Just like how you use `make -j NUM`\r\n```","created_at":"2015-11-01T12:43:02Z","updated_at":"2015-11-01T12:43:02Z","html_url":"https://github.com/ysshao/ALADDIN/pull/6#discussion_r43582084","pull_request_url":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6","_links":{"self":{"href":"https://api.github.com/repos/ysshao/ALADDIN/pulls/comments/43582084"},"html":{"href":"https://github.com/ysshao/ALADDIN/pull/6#discussion_r43582084"},"pull_request":{"href":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6"}}},"pull_request":{"url":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6","id":40301396,"html_url":"https://github.com/ysshao/ALADDIN/pull/6","diff_url":"https://github.com/ysshao/ALADDIN/pull/6.diff","patch_url":"https://github.com/ysshao/ALADDIN/pull/6.patch","issue_url":"https://api.github.com/repos/ysshao/ALADDIN/issues/6","number":6,"state":"open","locked":false,"title":"Write CMake scripts","user":{"login":"rgly","id":11572209,"avatar_url":"https://avatars.githubusercontent.com/u/11572209?v=3","gravatar_id":"","url":"https://api.github.com/users/rgly","html_url":"https://github.com/rgly","followers_url":"https://api.github.com/users/rgly/followers","following_url":"https://api.github.com/users/rgly/following{/other_user}","gists_url":"https://api.github.com/users/rgly/gists{/gist_id}","starred_url":"https://api.github.com/users/rgly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rgly/subscriptions","organizations_url":"https://api.github.com/users/rgly/orgs","repos_url":"https://api.github.com/users/rgly/repos","events_url":"https://api.github.com/users/rgly/events{/privacy}","received_events_url":"https://api.github.com/users/rgly/received_events","type":"User","site_admin":false},"body":"The CMake scripts finds and build with LLVM-Tracer. It adds unit-test and SHOC/ C examples as CTest and supports CMake options from LLVM-Tracer. I like CTest for it supports regular expression to choose the wanted tests to run.\r\n\r\nNote that the in-source-build is forbidden and BUILD_ON_SOURCE=FALSE by default in Aladdin.","created_at":"2015-07-19T01:17:05Z","updated_at":"2015-11-01T12:43:02Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c235674a62f2dc5d6e31e498bd08758b6019df0e","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6/commits","review_comments_url":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6/comments","review_comment_url":"https://api.github.com/repos/ysshao/ALADDIN/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ysshao/ALADDIN/issues/6/comments","statuses_url":"https://api.github.com/repos/ysshao/ALADDIN/statuses/2fd83c340db11f1111faae05bb305560437fde93","head":{"label":"rgly:master","ref":"master","sha":"2fd83c340db11f1111faae05bb305560437fde93","user":{"login":"rgly","id":11572209,"avatar_url":"https://avatars.githubusercontent.com/u/11572209?v=3","gravatar_id":"","url":"https://api.github.com/users/rgly","html_url":"https://github.com/rgly","followers_url":"https://api.github.com/users/rgly/followers","following_url":"https://api.github.com/users/rgly/following{/other_user}","gists_url":"https://api.github.com/users/rgly/gists{/gist_id}","starred_url":"https://api.github.com/users/rgly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rgly/subscriptions","organizations_url":"https://api.github.com/users/rgly/orgs","repos_url":"https://api.github.com/users/rgly/repos","events_url":"https://api.github.com/users/rgly/events{/privacy}","received_events_url":"https://api.github.com/users/rgly/received_events","type":"User","site_admin":false},"repo":{"id":36212628,"name":"ALADDIN","full_name":"rgly/ALADDIN","owner":{"login":"rgly","id":11572209,"avatar_url":"https://avatars.githubusercontent.com/u/11572209?v=3","gravatar_id":"","url":"https://api.github.com/users/rgly","html_url":"https://github.com/rgly","followers_url":"https://api.github.com/users/rgly/followers","following_url":"https://api.github.com/users/rgly/following{/other_user}","gists_url":"https://api.github.com/users/rgly/gists{/gist_id}","starred_url":"https://api.github.com/users/rgly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rgly/subscriptions","organizations_url":"https://api.github.com/users/rgly/orgs","repos_url":"https://api.github.com/users/rgly/repos","events_url":"https://api.github.com/users/rgly/events{/privacy}","received_events_url":"https://api.github.com/users/rgly/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/rgly/ALADDIN","description":"A pre-RTL, power-performance model for fixed-function accelerators","fork":true,"url":"https://api.github.com/repos/rgly/ALADDIN","forks_url":"https://api.github.com/repos/rgly/ALADDIN/forks","keys_url":"https://api.github.com/repos/rgly/ALADDIN/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rgly/ALADDIN/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rgly/ALADDIN/teams","hooks_url":"https://api.github.com/repos/rgly/ALADDIN/hooks","issue_events_url":"https://api.github.com/repos/rgly/ALADDIN/issues/events{/number}","events_url":"https://api.github.com/repos/rgly/ALADDIN/events","assignees_url":"https://api.github.com/repos/rgly/ALADDIN/assignees{/user}","branches_url":"https://api.github.com/repos/rgly/ALADDIN/branches{/branch}","tags_url":"https://api.github.com/repos/rgly/ALADDIN/tags","blobs_url":"https://api.github.com/repos/rgly/ALADDIN/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rgly/ALADDIN/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rgly/ALADDIN/git/refs{/sha}","trees_url":"https://api.github.com/repos/rgly/ALADDIN/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rgly/ALADDIN/statuses/{sha}","languages_url":"https://api.github.com/repos/rgly/ALADDIN/languages","stargazers_url":"https://api.github.com/repos/rgly/ALADDIN/stargazers","contributors_url":"https://api.github.com/repos/rgly/ALADDIN/contributors","subscribers_url":"https://api.github.com/repos/rgly/ALADDIN/subscribers","subscription_url":"https://api.github.com/repos/rgly/ALADDIN/subscription","commits_url":"https://api.github.com/repos/rgly/ALADDIN/commits{/sha}","git_commits_url":"https://api.github.com/repos/rgly/ALADDIN/git/commits{/sha}","comments_url":"https://api.github.com/repos/rgly/ALADDIN/comments{/number}","issue_comment_url":"https://api.github.com/repos/rgly/ALADDIN/issues/comments{/number}","contents_url":"https://api.github.com/repos/rgly/ALADDIN/contents/{+path}","compare_url":"https://api.github.com/repos/rgly/ALADDIN/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rgly/ALADDIN/merges","archive_url":"https://api.github.com/repos/rgly/ALADDIN/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rgly/ALADDIN/downloads","issues_url":"https://api.github.com/repos/rgly/ALADDIN/issues{/number}","pulls_url":"https://api.github.com/repos/rgly/ALADDIN/pulls{/number}","milestones_url":"https://api.github.com/repos/rgly/ALADDIN/milestones{/number}","notifications_url":"https://api.github.com/repos/rgly/ALADDIN/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rgly/ALADDIN/labels{/name}","releases_url":"https://api.github.com/repos/rgly/ALADDIN/releases{/id}","created_at":"2015-05-25T05:52:59Z","updated_at":"2015-05-25T05:53:01Z","pushed_at":"2015-07-18T13:36:17Z","git_url":"git://github.com/rgly/ALADDIN.git","ssh_url":"git@github.com:rgly/ALADDIN.git","clone_url":"https://github.com/rgly/ALADDIN.git","svn_url":"https://github.com/rgly/ALADDIN","homepage":null,"size":1981,"stargazers_count":0,"watchers_count":0,"language":"C++","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"ysshao:master","ref":"master","sha":"a45516977b52a38803b9f7b883ac16205e523a78","user":{"login":"ysshao","id":8195661,"avatar_url":"https://avatars.githubusercontent.com/u/8195661?v=3","gravatar_id":"","url":"https://api.github.com/users/ysshao","html_url":"https://github.com/ysshao","followers_url":"https://api.github.com/users/ysshao/followers","following_url":"https://api.github.com/users/ysshao/following{/other_user}","gists_url":"https://api.github.com/users/ysshao/gists{/gist_id}","starred_url":"https://api.github.com/users/ysshao/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ysshao/subscriptions","organizations_url":"https://api.github.com/users/ysshao/orgs","repos_url":"https://api.github.com/users/ysshao/repos","events_url":"https://api.github.com/users/ysshao/events{/privacy}","received_events_url":"https://api.github.com/users/ysshao/received_events","type":"User","site_admin":false},"repo":{"id":21959817,"name":"ALADDIN","full_name":"ysshao/ALADDIN","owner":{"login":"ysshao","id":8195661,"avatar_url":"https://avatars.githubusercontent.com/u/8195661?v=3","gravatar_id":"","url":"https://api.github.com/users/ysshao","html_url":"https://github.com/ysshao","followers_url":"https://api.github.com/users/ysshao/followers","following_url":"https://api.github.com/users/ysshao/following{/other_user}","gists_url":"https://api.github.com/users/ysshao/gists{/gist_id}","starred_url":"https://api.github.com/users/ysshao/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ysshao/subscriptions","organizations_url":"https://api.github.com/users/ysshao/orgs","repos_url":"https://api.github.com/users/ysshao/repos","events_url":"https://api.github.com/users/ysshao/events{/privacy}","received_events_url":"https://api.github.com/users/ysshao/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/ysshao/ALADDIN","description":"A pre-RTL, power-performance model for fixed-function accelerators","fork":false,"url":"https://api.github.com/repos/ysshao/ALADDIN","forks_url":"https://api.github.com/repos/ysshao/ALADDIN/forks","keys_url":"https://api.github.com/repos/ysshao/ALADDIN/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ysshao/ALADDIN/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ysshao/ALADDIN/teams","hooks_url":"https://api.github.com/repos/ysshao/ALADDIN/hooks","issue_events_url":"https://api.github.com/repos/ysshao/ALADDIN/issues/events{/number}","events_url":"https://api.github.com/repos/ysshao/ALADDIN/events","assignees_url":"https://api.github.com/repos/ysshao/ALADDIN/assignees{/user}","branches_url":"https://api.github.com/repos/ysshao/ALADDIN/branches{/branch}","tags_url":"https://api.github.com/repos/ysshao/ALADDIN/tags","blobs_url":"https://api.github.com/repos/ysshao/ALADDIN/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ysshao/ALADDIN/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ysshao/ALADDIN/git/refs{/sha}","trees_url":"https://api.github.com/repos/ysshao/ALADDIN/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ysshao/ALADDIN/statuses/{sha}","languages_url":"https://api.github.com/repos/ysshao/ALADDIN/languages","stargazers_url":"https://api.github.com/repos/ysshao/ALADDIN/stargazers","contributors_url":"https://api.github.com/repos/ysshao/ALADDIN/contributors","subscribers_url":"https://api.github.com/repos/ysshao/ALADDIN/subscribers","subscription_url":"https://api.github.com/repos/ysshao/ALADDIN/subscription","commits_url":"https://api.github.com/repos/ysshao/ALADDIN/commits{/sha}","git_commits_url":"https://api.github.com/repos/ysshao/ALADDIN/git/commits{/sha}","comments_url":"https://api.github.com/repos/ysshao/ALADDIN/comments{/number}","issue_comment_url":"https://api.github.com/repos/ysshao/ALADDIN/issues/comments{/number}","contents_url":"https://api.github.com/repos/ysshao/ALADDIN/contents/{+path}","compare_url":"https://api.github.com/repos/ysshao/ALADDIN/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ysshao/ALADDIN/merges","archive_url":"https://api.github.com/repos/ysshao/ALADDIN/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ysshao/ALADDIN/downloads","issues_url":"https://api.github.com/repos/ysshao/ALADDIN/issues{/number}","pulls_url":"https://api.github.com/repos/ysshao/ALADDIN/pulls{/number}","milestones_url":"https://api.github.com/repos/ysshao/ALADDIN/milestones{/number}","notifications_url":"https://api.github.com/repos/ysshao/ALADDIN/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ysshao/ALADDIN/labels{/name}","releases_url":"https://api.github.com/repos/ysshao/ALADDIN/releases{/id}","created_at":"2014-07-17T22:22:40Z","updated_at":"2015-10-21T04:59:49Z","pushed_at":"2015-07-19T01:17:06Z","git_url":"git://github.com/ysshao/ALADDIN.git","ssh_url":"git@github.com:ysshao/ALADDIN.git","clone_url":"https://github.com/ysshao/ALADDIN.git","svn_url":"https://github.com/ysshao/ALADDIN","homepage":null,"size":2369,"stargazers_count":5,"watchers_count":5,"language":"C++","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":10,"mirror_url":null,"open_issues_count":1,"forks":10,"open_issues":1,"watchers":5,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6"},"html":{"href":"https://github.com/ysshao/ALADDIN/pull/6"},"issue":{"href":"https://api.github.com/repos/ysshao/ALADDIN/issues/6"},"comments":{"href":"https://api.github.com/repos/ysshao/ALADDIN/issues/6/comments"},"review_comments":{"href":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6/comments"},"review_comment":{"href":"https://api.github.com/repos/ysshao/ALADDIN/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ysshao/ALADDIN/pulls/6/commits"},"statuses":{"href":"https://api.github.com/repos/ysshao/ALADDIN/statuses/2fd83c340db11f1111faae05bb305560437fde93"}}}}