mirror of
https://github.com/flynx/test.js.git
synced 2025-12-20 18:41:40 +00:00
more work on docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
207ac3802f
commit
1415d45de6
30
README.md
30
README.md
@ -13,7 +13,9 @@ XXX
|
||||
- [Architecture](#architecture)
|
||||
- [Combinational testing](#combinational-testing)
|
||||
- [Unit testing](#unit-testing)
|
||||
- [Installation](#installation)
|
||||
- [Basic usage](#basic-usage)
|
||||
- [CLI](#cli)
|
||||
- [Components](#components)
|
||||
- [`DEFAULT_TEST_FILES`](#default_test_files)
|
||||
- [`IGNORE_TEST_FILES`](#ignore_test_files)
|
||||
@ -84,8 +86,22 @@ This makes it simple to define procedural/generative tests.
|
||||
This is the traditional self-contained test approach.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
```shell_session
|
||||
npm install -g ig-test
|
||||
```
|
||||
|
||||
```shell_session
|
||||
npm install -i ig-test
|
||||
```
|
||||
|
||||
|
||||
## Basic usage
|
||||
|
||||
XXX script naming...
|
||||
|
||||
Create a test script
|
||||
```shell_session
|
||||
$ touch test.js
|
||||
$ chmod +x test.js
|
||||
@ -97,6 +113,8 @@ The code:
|
||||
|
||||
var test = require('ig-test')
|
||||
|
||||
// XXX add assert examples...
|
||||
|
||||
test.Setups({
|
||||
state: function(assert){
|
||||
return {
|
||||
@ -128,14 +146,22 @@ __filename == (require.main || {}).filename
|
||||
|
||||
Run the tests
|
||||
```shell_session
|
||||
$ runtests
|
||||
$ node ./test.js
|
||||
```
|
||||
|
||||
or
|
||||
```shell_session
|
||||
$ node ./test.js
|
||||
$ runtests
|
||||
```
|
||||
|
||||
## CLI
|
||||
|
||||
XXX help
|
||||
|
||||
XXX chains
|
||||
|
||||
XXX notes on coverage
|
||||
|
||||
|
||||
## Components
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "ig-test",
|
||||
"version": "1.4.1",
|
||||
"version": "1.4.2",
|
||||
"description": "experimental test runner....",
|
||||
"main": "test.js",
|
||||
"bin": {
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user