{"action":"created","comment":{"url":"https://api.github.com/repos/pybee/batavia/pulls/comments/85651928","pull_request_review_id":6357269,"id":85651928,"diff_hunk":"@@ -32,21 +32,81 @@ Javascript. With Batavia, you can run Python bytecode in your browser.\n It honors Python 3.4.4+ syntax and conventions, and let's you\n reference objects and classes defined natively in JavaScript.\n \n+Getting Started\n+---------------\n+\n+Getting a working local copy of Batavia requires a few steps: getting a copy of\n+the Batavia code, and the ouroboros dependency within a virtual environment.\n+\n+You'll need to have Pyhton 3.4 available for Batavia to work. Instructions on\n+how to set this up are `on our Environment setup guide\n+<http://pybee.org/contributing/first-time/setup/>`_. \n+\n+Setup a `pybee` folder to store everything::\n+\n+   $ mkdir pybee\n+   $ cd pybee\n+\n+Get a copy of the Batavia code by running a :code:`git clone`::\n+\n+   $ git clone https://github.com/pybee/batavia\n+\n+Batavia requires a copy of Ouroboros (the Python standard library, written in\n+Python) to build, so we also need to clone that::\n+\n+   $ git clone https://github.com/pybee/ouroboros\n+\n+Then, we need to create a virtual environment, and install Batavia into it.\n+\n+ * For Linux, MacOS::\n+\n+   $ virtualenv venv\n+   $ . venv/bin/activate\n+   $ cd batavia\n+   $ pip install -e .\n+\n+ * For Windows::\n+\n+   > virtualenv --python=c:\\python34\\python.exe env\n+   > cd env\\Scripts\n+   > activate\n+   > pip install -e .\n+\n+ * For Anaconda users::\n+\n+   $ cd batavia\n+   $ conda create -n batavia\n+   $ source activate batavia\n+   $ pip install -e .\n+\n+And finally, run the :code:`make` script to generate the combined Batavia JavaScript files::\n+\n+   $ make\n+\n+Your final setup should end up looking like this:: \n+\n+  _ pybee\n+    \\_ batavia\n+    \\_ ouroboros\n+    \\_ venv\n+\n+You now have a working Batavia environment!\n+\n Tutorial\n --------\n \n-To take Batavia for a spin, run through the `Getting Started guide`_.\n-\n-Then have some fun with `the first tutorial`_, and try out running Python in\n-your browser.\n+Once you've setup your environment, you can have some fun with `the first\n+tutorial`_, and try out running Python in your browser.\n \n-.. _Getting Started guide: https://batavia.readthedocs.io/en/latest/intro/getting-started.html\n .. _the first tutorial: https://batavia.readthedocs.io/en/latest/tutorials/tutorial-0.html\n \n Documentation\n -------------\n \n-Documentation for Batavia can be found on `Read The Docs`_.\n+Documentation for Batavia can be found on `Read The Docs`_, including:\n+\n+ * `So, why is it called \"Batavia\"? <https://batavia.readthedocs.io/en/latest/intro/faq.html#why-batavia>`_\n+ * `More Frequently Asked Questions <https://batavia.readthedocs.io/en/latest/intro/faq.html>`_","path":"README.rst","position":48,"original_position":84,"commit_id":"4098b78903abff3a8a88216d173e4c1d869f3616","original_commit_id":"3691102b9be6be3177090902af9c9e056f1245c1","user":{"login":"freakboy3742","id":37345,"avatar_url":"https://avatars.githubusercontent.com/u/37345?v=3","gravatar_id":"","url":"https://api.github.com/users/freakboy3742","html_url":"https://github.com/freakboy3742","followers_url":"https://api.github.com/users/freakboy3742/followers","following_url":"https://api.github.com/users/freakboy3742/following{/other_user}","gists_url":"https://api.github.com/users/freakboy3742/gists{/gist_id}","starred_url":"https://api.github.com/users/freakboy3742/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/freakboy3742/subscriptions","organizations_url":"https://api.github.com/users/freakboy3742/orgs","repos_url":"https://api.github.com/users/freakboy3742/repos","events_url":"https://api.github.com/users/freakboy3742/events{/privacy}","received_events_url":"https://api.github.com/users/freakboy3742/received_events","type":"User","site_admin":false},"body":"Minor markup thing: you need to strip the space before the bullet, or GitHub interprets it as a code sample.","created_at":"2016-10-30T02:39:05Z","updated_at":"2016-10-30T02:49:08Z","html_url":"https://github.com/pybee/batavia/pull/341#discussion_r85651928","pull_request_url":"https://api.github.com/repos/pybee/batavia/pulls/341","_links":{"self":{"href":"https://api.github.com/repos/pybee/batavia/pulls/comments/85651928"},"html":{"href":"https://github.com/pybee/batavia/pull/341#discussion_r85651928"},"pull_request":{"href":"https://api.github.com/repos/pybee/batavia/pulls/341"}}},"pull_request":{"url":"https://api.github.com/repos/pybee/batavia/pulls/341","id":91474824,"html_url":"https://github.com/pybee/batavia/pull/341","diff_url":"https://github.com/pybee/batavia/pull/341.diff","patch_url":"https://github.com/pybee/batavia/pull/341.patch","issue_url":"https://api.github.com/repos/pybee/batavia/issues/341","number":341,"state":"open","locked":false,"title":"Update README, Contributing, Internals","user":{"login":"glasnt","id":813732,"avatar_url":"https://avatars.githubusercontent.com/u/813732?v=3","gravatar_id":"","url":"https://api.github.com/users/glasnt","html_url":"https://github.com/glasnt","followers_url":"https://api.github.com/users/glasnt/followers","following_url":"https://api.github.com/users/glasnt/following{/other_user}","gists_url":"https://api.github.com/users/glasnt/gists{/gist_id}","starred_url":"https://api.github.com/users/glasnt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/glasnt/subscriptions","organizations_url":"https://api.github.com/users/glasnt/orgs","repos_url":"https://api.github.com/users/glasnt/repos","events_url":"https://api.github.com/users/glasnt/events{/privacy}","received_events_url":"https://api.github.com/users/glasnt/received_events","type":"User","site_admin":false},"body":"This adds the basic Getting Started guide to the README, removes a duplicate pun-reasoning, and other cleanups. \r\n\r\n\r\nI'm still not 100% happy with it, but I think it's an improvement. \r\n\r\n\r\nNote for self for later, `pip install restview; restview <filename>` makes for really nice RST previewing. \r\n\r\n","created_at":"2016-10-29T01:52:07Z","updated_at":"2016-10-30T02:49:08Z","closed_at":null,"merged_at":null,"merge_commit_sha":"2ec8afec0fdae6b4dbcc24e3c66f9caa22c103d9","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/pybee/batavia/pulls/341/commits","review_comments_url":"https://api.github.com/repos/pybee/batavia/pulls/341/comments","review_comment_url":"https://api.github.com/repos/pybee/batavia/pulls/comments{/number}","comments_url":"https://api.github.com/repos/pybee/batavia/issues/341/comments","statuses_url":"https://api.github.com/repos/pybee/batavia/statuses/4098b78903abff3a8a88216d173e4c1d869f3616","head":{"label":"pybee:topic/readme","ref":"topic/readme","sha":"4098b78903abff3a8a88216d173e4c1d869f3616","user":{"login":"pybee","id":5001767,"avatar_url":"https://avatars.githubusercontent.com/u/5001767?v=3","gravatar_id":"","url":"https://api.github.com/users/pybee","html_url":"https://github.com/pybee","followers_url":"https://api.github.com/users/pybee/followers","following_url":"https://api.github.com/users/pybee/following{/other_user}","gists_url":"https://api.github.com/users/pybee/gists{/gist_id}","starred_url":"https://api.github.com/users/pybee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pybee/subscriptions","organizations_url":"https://api.github.com/users/pybee/orgs","repos_url":"https://api.github.com/users/pybee/repos","events_url":"https://api.github.com/users/pybee/events{/privacy}","received_events_url":"https://api.github.com/users/pybee/received_events","type":"Organization","site_admin":false},"repo":{"id":40421806,"name":"batavia","full_name":"pybee/batavia","owner":{"login":"pybee","id":5001767,"avatar_url":"https://avatars.githubusercontent.com/u/5001767?v=3","gravatar_id":"","url":"https://api.github.com/users/pybee","html_url":"https://github.com/pybee","followers_url":"https://api.github.com/users/pybee/followers","following_url":"https://api.github.com/users/pybee/following{/other_user}","gists_url":"https://api.github.com/users/pybee/gists{/gist_id}","starred_url":"https://api.github.com/users/pybee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pybee/subscriptions","organizations_url":"https://api.github.com/users/pybee/orgs","repos_url":"https://api.github.com/users/pybee/repos","events_url":"https://api.github.com/users/pybee/events{/privacy}","received_events_url":"https://api.github.com/users/pybee/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/pybee/batavia","description":"A Javascript implementation of the Python virtual machine.","fork":false,"url":"https://api.github.com/repos/pybee/batavia","forks_url":"https://api.github.com/repos/pybee/batavia/forks","keys_url":"https://api.github.com/repos/pybee/batavia/keys{/key_id}","collaborators_url":"https://api.github.com/repos/pybee/batavia/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/pybee/batavia/teams","hooks_url":"https://api.github.com/repos/pybee/batavia/hooks","issue_events_url":"https://api.github.com/repos/pybee/batavia/issues/events{/number}","events_url":"https://api.github.com/repos/pybee/batavia/events","assignees_url":"https://api.github.com/repos/pybee/batavia/assignees{/user}","branches_url":"https://api.github.com/repos/pybee/batavia/branches{/branch}","tags_url":"https://api.github.com/repos/pybee/batavia/tags","blobs_url":"https://api.github.com/repos/pybee/batavia/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/pybee/batavia/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/pybee/batavia/git/refs{/sha}","trees_url":"https://api.github.com/repos/pybee/batavia/git/trees{/sha}","statuses_url":"https://api.github.com/repos/pybee/batavia/statuses/{sha}","languages_url":"https://api.github.com/repos/pybee/batavia/languages","stargazers_url":"https://api.github.com/repos/pybee/batavia/stargazers","contributors_url":"https://api.github.com/repos/pybee/batavia/contributors","subscribers_url":"https://api.github.com/repos/pybee/batavia/subscribers","subscription_url":"https://api.github.com/repos/pybee/batavia/subscription","commits_url":"https://api.github.com/repos/pybee/batavia/commits{/sha}","git_commits_url":"https://api.github.com/repos/pybee/batavia/git/commits{/sha}","comments_url":"https://api.github.com/repos/pybee/batavia/comments{/number}","issue_comment_url":"https://api.github.com/repos/pybee/batavia/issues/comments{/number}","contents_url":"https://api.github.com/repos/pybee/batavia/contents/{+path}","compare_url":"https://api.github.com/repos/pybee/batavia/compare/{base}...{head}","merges_url":"https://api.github.com/repos/pybee/batavia/merges","archive_url":"https://api.github.com/repos/pybee/batavia/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/pybee/batavia/downloads","issues_url":"https://api.github.com/repos/pybee/batavia/issues{/number}","pulls_url":"https://api.github.com/repos/pybee/batavia/pulls{/number}","milestones_url":"https://api.github.com/repos/pybee/batavia/milestones{/number}","notifications_url":"https://api.github.com/repos/pybee/batavia/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/pybee/batavia/labels{/name}","releases_url":"https://api.github.com/repos/pybee/batavia/releases{/id}","deployments_url":"https://api.github.com/repos/pybee/batavia/deployments","created_at":"2015-08-09T01:40:34Z","updated_at":"2016-10-27T19:51:25Z","pushed_at":"2016-10-29T20:43:10Z","git_url":"git://github.com/pybee/batavia.git","ssh_url":"git@github.com:pybee/batavia.git","clone_url":"https://github.com/pybee/batavia.git","svn_url":"https://github.com/pybee/batavia","homepage":"http://pybee.org/batavia","size":21104,"stargazers_count":407,"watchers_count":407,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":161,"mirror_url":null,"open_issues_count":35,"forks":161,"open_issues":35,"watchers":407,"default_branch":"master"}},"base":{"label":"pybee:master","ref":"master","sha":"6d7e04c7d0f30aa0d4d5a87cbae9fde6581df30f","user":{"login":"pybee","id":5001767,"avatar_url":"https://avatars.githubusercontent.com/u/5001767?v=3","gravatar_id":"","url":"https://api.github.com/users/pybee","html_url":"https://github.com/pybee","followers_url":"https://api.github.com/users/pybee/followers","following_url":"https://api.github.com/users/pybee/following{/other_user}","gists_url":"https://api.github.com/users/pybee/gists{/gist_id}","starred_url":"https://api.github.com/users/pybee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pybee/subscriptions","organizations_url":"https://api.github.com/users/pybee/orgs","repos_url":"https://api.github.com/users/pybee/repos","events_url":"https://api.github.com/users/pybee/events{/privacy}","received_events_url":"https://api.github.com/users/pybee/received_events","type":"Organization","site_admin":false},"repo":{"id":40421806,"name":"batavia","full_name":"pybee/batavia","owner":{"login":"pybee","id":5001767,"avatar_url":"https://avatars.githubusercontent.com/u/5001767?v=3","gravatar_id":"","url":"https://api.github.com/users/pybee","html_url":"https://github.com/pybee","followers_url":"https://api.github.com/users/pybee/followers","following_url":"https://api.github.com/users/pybee/following{/other_user}","gists_url":"https://api.github.com/users/pybee/gists{/gist_id}","starred_url":"https://api.github.com/users/pybee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pybee/subscriptions","organizations_url":"https://api.github.com/users/pybee/orgs","repos_url":"https://api.github.com/users/pybee/repos","events_url":"https://api.github.com/users/pybee/events{/privacy}","received_events_url":"https://api.github.com/users/pybee/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/pybee/batavia","description":"A Javascript implementation of the Python virtual machine.","fork":false,"url":"https://api.github.com/repos/pybee/batavia","forks_url":"https://api.github.com/repos/pybee/batavia/forks","keys_url":"https://api.github.com/repos/pybee/batavia/keys{/key_id}","collaborators_url":"https://api.github.com/repos/pybee/batavia/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/pybee/batavia/teams","hooks_url":"https://api.github.com/repos/pybee/batavia/hooks","issue_events_url":"https://api.github.com/repos/pybee/batavia/issues/events{/number}","events_url":"https://api.github.com/repos/pybee/batavia/events","assignees_url":"https://api.github.com/repos/pybee/batavia/assignees{/user}","branches_url":"https://api.github.com/repos/pybee/batavia/branches{/branch}","tags_url":"https://api.github.com/repos/pybee/batavia/tags","blobs_url":"https://api.github.com/repos/pybee/batavia/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/pybee/batavia/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/pybee/batavia/git/refs{/sha}","trees_url":"https://api.github.com/repos/pybee/batavia/git/trees{/sha}","statuses_url":"https://api.github.com/repos/pybee/batavia/statuses/{sha}","languages_url":"https://api.github.com/repos/pybee/batavia/languages","stargazers_url":"https://api.github.com/repos/pybee/batavia/stargazers","contributors_url":"https://api.github.com/repos/pybee/batavia/contributors","subscribers_url":"https://api.github.com/repos/pybee/batavia/subscribers","subscription_url":"https://api.github.com/repos/pybee/batavia/subscription","commits_url":"https://api.github.com/repos/pybee/batavia/commits{/sha}","git_commits_url":"https://api.github.com/repos/pybee/batavia/git/commits{/sha}","comments_url":"https://api.github.com/repos/pybee/batavia/comments{/number}","issue_comment_url":"https://api.github.com/repos/pybee/batavia/issues/comments{/number}","contents_url":"https://api.github.com/repos/pybee/batavia/contents/{+path}","compare_url":"https://api.github.com/repos/pybee/batavia/compare/{base}...{head}","merges_url":"https://api.github.com/repos/pybee/batavia/merges","archive_url":"https://api.github.com/repos/pybee/batavia/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/pybee/batavia/downloads","issues_url":"https://api.github.com/repos/pybee/batavia/issues{/number}","pulls_url":"https://api.github.com/repos/pybee/batavia/pulls{/number}","milestones_url":"https://api.github.com/repos/pybee/batavia/milestones{/number}","notifications_url":"https://api.github.com/repos/pybee/batavia/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/pybee/batavia/labels{/name}","releases_url":"https://api.github.com/repos/pybee/batavia/releases{/id}","deployments_url":"https://api.github.com/repos/pybee/batavia/deployments","created_at":"2015-08-09T01:40:34Z","updated_at":"2016-10-27T19:51:25Z","pushed_at":"2016-10-29T20:43:10Z","git_url":"git://github.com/pybee/batavia.git","ssh_url":"git@github.com:pybee/batavia.git","clone_url":"https://github.com/pybee/batavia.git","svn_url":"https://github.com/pybee/batavia","homepage":"http://pybee.org/batavia","size":21104,"stargazers_count":407,"watchers_count":407,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":161,"mirror_url":null,"open_issues_count":35,"forks":161,"open_issues":35,"watchers":407,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/pybee/batavia/pulls/341"},"html":{"href":"https://github.com/pybee/batavia/pull/341"},"issue":{"href":"https://api.github.com/repos/pybee/batavia/issues/341"},"comments":{"href":"https://api.github.com/repos/pybee/batavia/issues/341/comments"},"review_comments":{"href":"https://api.github.com/repos/pybee/batavia/pulls/341/comments"},"review_comment":{"href":"https://api.github.com/repos/pybee/batavia/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/pybee/batavia/pulls/341/commits"},"statuses":{"href":"https://api.github.com/repos/pybee/batavia/statuses/4098b78903abff3a8a88216d173e4c1d869f3616"}}}}
{"actor":{"display_login":"freakboy3742"}}