From: Jason Woofenden Date: Fri, 22 Jan 2016 00:33:52 +0000 (-0500) Subject: update documentation X-Git-Url: https://jasonwoof.com/gitweb/?p=peach-html5-editor.git;a=commitdiff_plain;h=071a77b51a7f9ba5da51b3fc43885e63771bc566 update documentation --- diff --git a/README.md b/README.md index b414c02..02020d6 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ WYSIWYG editor: planning stages Quick Start Guide ----------------- -1. Open ``test.html`` in your browser. +1. Open ``parser_tests_coffee.html`` in your browser. 2. Open the console (right-click, inspect this element, console) @@ -36,35 +36,49 @@ For further reading, see "Running Under node.js" below. Running Under node.js --------------------- -Dependancies: node.js, coffeescript +Dependencies: node.js, CoffeeScript 1. Install node.js https://nodejs.org/en/ -2. Install coffeescript. Try: +2. Install CoffeeScript. Try: apt-get install coffeescript or npm install -g coffee-script -3. You can run the tests directly from coffeescript: - - coffee test.coffee - 4. Compile to javascript: make -5. Run tests via compiled code: +Now you can do any of these things in any order: + +* Run the tests directly from CoffeeScript: + + coffee test.coffee + +* Test the compiled (javascript) parser in your favorite browser by opening + up ``parser_tests.html`` and looking at the console. + +* Run tests via compiled code: nodejs test.js -5. Try using the parser in your own code: +* Try using the parser in your own javascript node.js project: var wheic = require('./parse-html.js'); var dom = wheic.parse_html("

", {fragment: 'body'}); ... +* Try using the parser in your own CoffeeScript node.js project: + + wheic = require './parse-html.js' + dom = wheic.parse_html "

", fragment: 'body' + ... + + Note: the CoffeeScript compile time is significant, so you'll want to use + the compiled javascript even though you could use the ``.coffee`` version. + Feedback, Questions, Etc ------------------------ diff --git a/parser_tests.html b/parser_tests.html new file mode 100644 index 0000000..f0c7c82 --- /dev/null +++ b/parser_tests.html @@ -0,0 +1,16 @@ + + + + + + html parser tester + + +

WHEIC html parser test page (javascript version)

You'll need to run make to build the javascript files used on this page.

If you don't have node.js and CoffeeScript installed, you can use the other test page which compiles the CoffeeScript files on the fly in the browser.

Check the inspector/console for test results.

+ + + + diff --git a/parser_tests_coffee.html b/parser_tests_coffee.html new file mode 100644 index 0000000..2f370ab --- /dev/null +++ b/parser_tests_coffee.html @@ -0,0 +1,17 @@ + + + + + + html parser tester + + +

WHEIC html parser test page (CoffeeScript version)

This version of the test page compiles the CoffeeScript files in the browser, so you don't have to install CoffeeScript (or node.js).

It can take a few seconds for the tests to compile.

Check the inspector/console for test results.

+ + + + + diff --git a/test.html b/test.html deleted file mode 100644 index 6343102..0000000 --- a/test.html +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - html parser tester - - -

WHEIC test page.

It can take a few seconds for the tests to compile.

Check the inspector/console for test results.

- - - - -