Skip to content

Commit

Permalink
update development log
Browse files Browse the repository at this point in the history
  • Loading branch information
mikolalysenko committed May 18, 2016
1 parent c0143ff commit ebf1824
Showing 1 changed file with 30 additions and 22 deletions.
52 changes: 30 additions & 22 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,52 @@

## Style

`regl` uses [standard](https://github.com/feross/standard) style
* `regl` ahderes to the [standard](https://github.com/feross/standard) style.
* Write all test cases, benchmarks and library code using strict ES5 style.
* Write examples using ES6

## Testing
## Development set up

regl uses [tape](https://www.npmjs.com/package/tape)
* To set up the development environment for regl, you first need to install [nodejs](https://nodejs.org/en/). Any version >0.10 is supported.
* Once this is done, you can install regl's development dependencies using the following npm command:

### Running tests
```
npm install
```

#### In node
With headless-gl, you can just do:
## Testing and benchmarks

* regl uses [tape](https://www.npmjs.com/package/tape) for unit testing
* To run the test cases in node, use the following command:
```
npm run test
```

Which should run all test cases

#### In the browser

* To run the test cases in your web browser, use:
```
npm run test-browser
```

### Adding tests

### Test coverage

* To add a test case, create a new file in the `test/` folder and then add a reference to it in `test/util/index.js`
* To generate a code coverage report, you can run the following command. A report webpage will the be generated in `coverage/lcov-report/index.html`
```
npm run coverage
```
* To run benchmarks, use this command:
```
npm run bench
```
* The easiest way to add a new benchmark is to copy an existing benchmark (see for example `bench/clear.js`), modify it, and add an entry to `bench/list.js`

## Benchmarks

### Running benchmarks
## Building

* To rebuild all redistributable assets and the static website, use the command:
```
npm run bench
npm run build
```
* If you just want to modify the examples, you can do
```
npm run build-gallery
```

## How to help out

### Adding benchmarks
Copy an existing benchmark (see for example `bench/clear.js`) and add it to `bench/list.js`
Check out the [change log](CHANGES.md) for planned features and tasks. Alternatively, if you want to propose a new feature or report a bug, you should open an issue on GitHub.

0 comments on commit ebf1824

Please sign in to comment.