Merge pull request #17 from blob8108/testing-info

Instructions for running locally in TESTING.md

README.md

@@ -1,9 +1,16 @@
-Scratch HTML5 Player
+# Scratch HTML5 Player
 
 This project aims to create a Scratch Player in HTML5.  Scratch is currently implemented with Actionscript 3 and requires the Flash Player version 10.2.  Since Flash does not run on iOS (iPads, iPods, etc) and newer Android devices, we would like to have an HTML5 version to display (but not edit) projects on mobile devices. Scratch projects played in the HTML5 player should look and behave as closely as possible to the way they look and behave when played by the Flash player.  We will not be accepting pull requests for new features that don't already exist in the Flash based Scratch project player.
 
-There are a few github issues created that represent some of the missing features.  At this point, the HTML5 player is about 40% complete and can run some simple projects.  Running the HTML5 player on your own website, or locally, you will need to have PHP so that the proxy.php file can be used to load assets from the same domain.  This is done to be compatible with Javascript security models in today's browsers.  To test the HTML5 player against the Flash player you can use the compare.html web page.
+There are a few github issues created that represent some of the missing features.  At this point, the HTML5 player is about 40% complete and can run some simple projects.
 
 Unimplementable Features on iOS: Image effects for whirl, fisheye, mosaic, and pixelate.  Sound and video input for loudness, video motion, and touching colors from the video.
 
 More documentation will be added as time permits. Thanks for contributing, and Scratch On!
+
+## Installation
+
+Running the HTML5 player on your own website, or locally, you will need to have
+PHP so that the `proxy.php` file can be used to load assets from the same domain.  This is done to be compatible with Javascript security models in today's browsers.  To test the HTML5 player against the Flash player you can use the compare.html web page.
+
+See the file `TESTING.md` for more details.

TESTING.md

@@ -0,0 +1,45 @@
+Running the HTML5 player on your own website, or locally, you will need to have
+PHP so that the `proxy.php` file can be used to load assets from the same domain.  This is done to be compatible with Javascript security models in today's browsers.  To test the HTML5 player against the Flash player you can use the compare.html web page.
+
+# Ubuntu
+
+If you're using Ubuntu, you can follow the following steps to set up the proxy correctly. You'll need to type the following commands in Terminal.
+
+Install PHP and Apache for running the proxy file:
+
+    $ sudo apt-get install apache2 php5
+
+Fork this repository on Github, and then clone it into your home folder somewhere (replacing `<username>` with your Github username):
+
+    $ git clone https://github.com/<username>/scratch-html5
+
+We'd like to add a new localhost domain, so that we can access the player from our web browser. Something like `scratch.localhost`. Run this command to edit the `/etc/hosts` file:
+
+    $ sudo nano /etc/hosts
+
+Add the following line:
+
+    127.0.0.1	scratch.localhost
+
+Use <key>Ctrl-O</key>, <key>Return</key>, <key>Ctrl-X</key> to quit.
+
+Now we want to add a new Apache configuration for the new domain. Run the following:
+
+    $ cd /etc/apache2/sites-available/
+    $ sudo nano scratch
+
+And type in the following, replacing `user` with your username, and making sure the `DocumentRoot` matches where you cloned the repository earlier:
+
+    <VirtualHost *:80>
+        ServerName scratch.localhost
+        DocumentRoot /home/user/scratch-html5
+    </VirtualHost>
+
+Finally, run the following commands to enable the site:
+
+    $ sudo a2ensite scratch
+    $ sudo service apache2 reload
+
+Now when you go to <http://scratch.localhost/>, the project should play. If you get a "Forbidden" error message, you may need to check the permissions of the folders that the player code is in.
+
+Now you can go fix bugs in the HTML5 player!