UNPKG

kontra

Version:

Kontra HTML5 game development library

github.com/straker/kontra

straker/kontra

29 lines (16 loc) • 1.49 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
[![GitHub version](https://badge.fury.io/gh/straker%2Fkontra.svg)](https://badge.fury.io/gh/straker%2Fkontra) [![Build Status](https://travis-ci.org/straker/kontra.svg?branch=master)](https://travis-ci.org/straker/kontra) [![Coverage Status](https://coveralls.io/repos/straker/kontra/badge.svg?branch=master&service=github)](https://coveralls.io/github/straker/kontra?branch=master) # Kontra.js A lightweight JavaScript gaming micro-library, optimized for js13kGames. ## Documentation All the documentation can be found on the [github page](https://straker.github.io/kontra/). ## Contributing ### Building To build the development code, run `npm run build`. To build the distribution version of the code, run `npm run dist`. Both should be built before submitting a pull request. ### Testing Please add unit and/or integration tests for all new changes. To run the tests, run `npm test`. ### Docs The documentation is built from the JSDoc comments in the source files using [LivingCSS](https://github.com/straker/livingcss) (I know, not what it was intended for but it makes it really easy to build multiple pages of docs. And it's highly configurable). To update the docs just modify the JSDoc comments. The docs are built along with the development version of the code, so running `npm run build` will build the docs as well. This ensures they stay in sync with any changes to the code. All doc related gulp tasks and `@tag` information can be found in the `doc-tasks.js` file.