Skip to content
This repository has been archived by the owner on Nov 4, 2023. It is now read-only.

Commit

Permalink
Add “Development” section to readme
Browse files Browse the repository at this point in the history
- It includes the old “Tests” section, but improved.
- Mention `xpkg` and x-package.json5
- Add instructions on how to generate the browser version.
  • Loading branch information
lydell committed May 5, 2014
1 parent 5b0eee8 commit 19688e3
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions readme.md
Expand Up @@ -141,12 +141,34 @@ to the async versions, except:
- They throw errors and return the result instead of using a callback.


Development
===========

Tests
=====
-----

First off, run `npm install` to install testing modules and browser polyfills.

`npm test` lints the code and runs the test suite in Node.js.

To run the tests in a browser, run `testling` (`npm install -g testling`) or
`testling -u`.

x-package.json5
---------------

package.json, component.json and bower.json are all generated from
x-package.json5 by using `[xpkg]`. Only edit x-package.json5, and remember to
run `xpkg` before commiting!

[xpkg]: https://github.com/kof/node-xpkg

Start by running `npm test`, which lints the code and runs the test suite in Node.js.
Generating the browser version
------------------------------

To run the tests in a browser, run `testling` (`npm install -g testling`) or `testling -u`.
source-map-resolve.js is generated from source-map-resolve-node.js and
source-map-resolve-template.js. Only edit the two latter files, _not_
source-map-resolve.js! To generate it, run `node generate-source-map-resolve.js`


License
Expand Down

0 comments on commit 19688e3

Please sign in to comment.