From 75c8c1e17de5376a04baf221456b4d0119f74c1c Mon Sep 17 00:00:00 2001 From: Adam Barth Date: Thu, 23 Oct 2014 20:32:07 -0700 Subject: [PATCH] Fill in some missing sections in the Sky README.md R=ojan@chromium.org Review URL: https://codereview.chromium.org/679583002 --- HACKING.md | 23 ++++++++++------------- README.md | 9 ++++++--- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/HACKING.md b/HACKING.md index e53c80d69..65f881100 100644 --- a/HACKING.md +++ b/HACKING.md @@ -4,42 +4,39 @@ Hacking on Sky 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`` Running applications -------------------- -* ``./sky/tools/skydb --debug`` +* ``./sky/tools/skydb [url]`` * You should see a ``(skydb)`` prompt * 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`` * This should run the tests Running tests manually ----------------------------- +---------------------- - * ``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`` - * 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 - * The harness should print the results of the test. You can then type another URL. +* ``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`` +* 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 +* The harness should print the results of the test. You can then type another URL. 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/): -``` +```html describe('My pretty test of my subject', function() { var subject = new MySubject(); it('should be pretty', function() { assert.ok(subject.isPretty); }); - }); ``` diff --git a/README.md b/README.md index b750fc08d..a4f2eda82 100644 --- a/README.md +++ b/README.md @@ -143,10 +143,13 @@ encode and decode messages sent over Mojo pipes. 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 ------------ -TODO: Link to HACKING.md, which contains the instructions for hacking on Sky. -TODO: Link to mailing list and IRC channel. +Instructions for building and testing Sky are contained in [HACKING.md]. For +coordination, we use the ``#mojo`` IRC channel on +[Freenode](https://freenode.net/). -- GitLab