Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: README.md

Issue 29367181: Issue 4726 - Add tests for the element hiding emulation content script (Closed) Base URL: https://bitbucket.org/fhd/adblockpluscore
Patch Set: Rebased on master, added tests for braces in regexp property selectors Created Dec. 13, 2016, 5:26 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | package.json » ('j') | package.json » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
===================================================================
--- a/README.md
+++ b/README.md
@@ -4,14 +4,32 @@
This repository contains the generic Adblock Plus code that's shared between
platforms. This repository is not designed to be used directly, but instead to
serve as a dependency for `adblockplus`, `adblockpluschrome` and
`libadblockplus`.
Running the unit tests
----------------------
+### Requirements
kzar 2017/01/09 08:28:42 If switching to this syntax for the headers mind u
Felix Dahlke 2017/01/10 09:16:47 Markdown only has the underlined syntax for level
kzar 2017/01/10 11:05:33 Well you're right the need for the different level
+
In order to run the unit test suite you need
[Node.js 6 or higher](https://nodejs.org/). Once Node.js is installed please run
`npm install` in the repository directory in order to install the required
-dependencies. After that you can run `npm test` which will execute all tests
-in the `test` directory of the repository. You can also specify specific test
-files on the command line, e.g. `npm test test/synchronizer.js`.
+dependencies.
+
+### Running all tests
+
+`npm test` will run all tests in the `test` directory of the repository.
+
+### Node.js tests
kzar 2017/01/09 08:28:42 I'd prefer to call these unit tests rather than No
Felix Dahlke 2017/01/10 09:16:47 I'll rewrite this section when removing the `test-
+
+`npm run test-node` will only run the tests that work in a Node.js environment.
+
+You can specify specific test files on the command line, e.g.
+`npm run test-node test/synchronizer.js`.
+
+### Browser tests
+
+`npm run test-browser` will only run the tests that require a browser
+environment.
+
+You can run these tests in a real browser by opening `test/browser/index.html`.
« no previous file with comments | « no previous file | package.json » ('j') | package.json » ('J')

Powered by Google App Engine
This is Rietveld