firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fill in some missing sections in the Sky README.md

Browse Source 
R=ojan@chromium.org

Review URL: https://codereview.chromium.org/679583002
This commit is contained in:
Adam Barth 2014-10-23 20:32:07 -07:00
parent 52e4bc9c93
commit a6d358ef47
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
engine/src/flutter/HACKING.md
View File

@ -4,42 +4,39 @@ Hacking on Sky
Building Building
-------- --------
* Follow the setup & build instructions for [mojo](https://github.com/domokit/mojo) * Follow the setup & build instructions for [Mojo](https://github.com/domokit/mojo)
* Build ``sky`` with ``ninja``, e.g. ``ninja -C out/Debug sky`` * Build ``sky`` with ``ninja``, e.g. ``ninja -C out/Debug sky``
Running applications Running applications
-------------------- --------------------
* ``./sky/tools/skydb --debug`` * ``./sky/tools/skydb [url]``
* You should see a ``(skydb)`` prompt * You should see a ``(skydb)`` prompt
* Type ``help`` to see the list of available commands * Type ``help`` to see the list of available commands
* The most common command is to load a URL, which youc an do simply by typing
the URL. To reload the current page, type enter.
* ``./sky/tools/test_sky --debug`` * ``./sky/tools/test_sky --debug``
* This should run the tests * This should run the tests
Running tests manually Running tests manually
---------------------------- ----------------------
* ``sky/tools/run_sky_httpd`` * ``sky/tools/run_sky_httpd``
* ``out/Debug/mojo_shell --args-for="mojo://native_viewport_service/ --use-headless-config" --content-handlers=text/html,mojo://sky_viewer/ --url-mappings=mojo:window_manager=mojo:sky_tester mojo:window_manager`` * ``out/Debug/mojo_shell --args-for="mojo://native_viewport_service/ --use-headless-config" --content-handlers=text/html,mojo://sky_viewer/ --url-mappings=mojo:window_manager=mojo:sky_tester mojo:window_manager``
* The ``sky_tester`` should print ``#READY`` when ready * The ``sky_tester`` should print ``#READY`` when ready
* Type the URL you wish to run, for example ``http://127.0.0.1:8000/lowlevel/text.html``, and press the enter key * Type the URL you wish to run, for example ``http://127.0.0.1:8000/lowlevel/text.html``, and press the enter key
* The harness should print the results of the test. You can then type another URL. * The harness should print the results of the test. You can then type another URL.
Writing tests Writing tests
------------- -------------
* Import ``tests/http/tests/resources/mocha.html`` * Import ``resources/mocha.html`` and ``resources/chai.html``
* Write tests in [mocha format](http://visionmedia.github.io/mocha/#getting-started) and use [chai asserts](http://chaijs.com/api/assert/): * Write tests in [mocha format](http://visionmedia.github.io/mocha/#getting-started) and use [chai asserts](http://chaijs.com/api/assert/):
``` ```html
describe('My pretty test of my subject', function() { describe('My pretty test of my subject', function() {
var subject = new MySubject(); var subject = new MySubject();
it('should be pretty', function() { it('should be pretty', function() {
assert.ok(subject.isPretty); assert.ok(subject.isPretty);
}); });
}); });
``` ```

9
engine/src/flutter/README.md
View File

@ -143,10 +143,13 @@ encode and decode messages sent over Mojo pipes.
Specifications Specifications
-------------- --------------
TODO: Link to the specs. We're documenting Sky with a [set of technical specifications](specs) that
define precisely the behavior of the engine. Currently both the implementation
and the specification are in flux, but hopefully they'll converge over time.
Contributing Contributing
------------ ------------
TODO: Link to HACKING.md, which contains the instructions for hacking on Sky. Instructions for building and testing Sky are contained in [HACKING.md]. For
TODO: Link to mailing list and IRC channel. coordination, we use the ``#mojo`` IRC channel on
[Freenode](https://freenode.net/).