1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/editor/libeditor/html/tests/browserscope/lib/richtext2/README Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,58 @@ 1.4 +README FOR BROWSERSCOPE 1.5 +----------------------- 1.6 + 1.7 +Hey there - thanks for downloading the code. This file has instructions 1.8 +for getting setup so that you can run the codebase locally. 1.9 + 1.10 +This project is built on Google App Engine using the 1.11 +Django web application framework and written in Python. 1.12 + 1.13 +To get started, you'll need to first download the App Engine SDK at: 1.14 +http://code.google.com/appengine/downloads.html 1.15 + 1.16 +For local development, just startup the server: 1.17 +./pathto/google_appengine/dev_appserver.py --port=8080 browserscope 1.18 + 1.19 +You should then be able to access the local application at: 1.20 +http://localhost:8080/ 1.21 + 1.22 +Note: the first time you hit the homepage it may take a little 1.23 +while - that's because it's trying to read out median times for all 1.24 +of the tests from a nonexistent datastore and write to memcache. 1.25 +Just be a lil patient. 1.26 + 1.27 +You can run the unit tests at: 1.28 + http://localhost:8080/test 1.29 + 1.30 + 1.31 +CONTRIBUTING 1.32 +------------------ 1.33 + 1.34 +Most likely you are interested in adding new tests or creating 1.35 +a new test category. If you are interested in adding tests to an existing 1.36 +"category" you may want to get in touch with the maintainer for that 1.37 +branch of the tree. We are really looking forward to receiving your 1.38 +code in patch format. Currently the category maintainers are: 1.39 +Network: Steve Souders <souders@gmail.com> 1.40 +Reflow: Lindsey Simon <elsigh@gmail.com> 1.41 +Security: Adam Barth <adam@adambarth.com> and Collin Jackson <collin@collinjackson.com> 1.42 + 1.43 + 1.44 +To create a completely new test category: 1.45 + * Copy one of the existing directories in categories/ 1.46 + * Edit your test_set.py, handlers.py 1.47 + * Add your files in templates/ and static/ 1.48 + * Update urls.py and settings.CATEGORIES 1.49 + * Follow the examples of other tests re: 1.50 + * beaconing using/testdriver_base 1.51 + * your GetScoreAndDisplayValue method 1.52 + * your GetRowScoreAndDisplayValue method 1.53 + 1.54 +References: 1.55 + * App Engine Docs - http://code.google.com/appengine/docs/python/overview.html 1.56 + * App Engine Group - http://groups.google.com/group/google-appengine 1.57 + * Python Docs - http://www.python.org/doc/ 1.58 + * Django - http://www.djangoproject.com/ 1.59 + 1.60 + 1.61 +