vnfmarket/src/main/webapp/vnfmarket/node_modules/karma/README.md

   1 # Karma
   2 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/karma-runner/karma) [![npm version](https://img.shields.io/npm/v/karma.svg?style=flat-square)](https://www.npmjs.com/package/karma) [![npm downloads](https://img.shields.io/npm/dm/karma.svg?style=flat-square)](https://www.npmjs.com/package/karma)
   3
   4 [![Build Status](https://img.shields.io/travis/karma-runner/karma/master.svg?style=flat-square)](https://travis-ci.org/karma-runner/karma) [![Code Climate](https://img.shields.io/codeclimate/github/karma-runner/karma.svg?style=flat-square)](https://codeclimate.com/github/karma-runner/karma) [![Dependency Status](https://img.shields.io/david/karma-runner/karma.svg?style=flat-square)](https://david-dm.org/karma-runner/karma) [![devDependency Status](https://img.shields.io/david/dev/karma-runner/karma.svg?style=flat-square)](https://david-dm.org/karma-runner/karma#info=devDependencies)
   5
   6 A simple tool that allows you to execute JavaScript code in multiple
   7 _real_ browsers.
   8
   9 > The main purpose of Karma is to make your test-driven development easy,
  10 >  fast, and fun.
  11
  12
  13 ## Help and Support
  14
  15 * Obligatory [documentation]
  16 * Quick questions:
  17 [![Gitter Chat](https://img.shields.io/badge/GITTER-join%20chat-green.svg?style=flat-square)](https://gitter.im/karma-runner/karma)
  18 * Longer questions: [Mailing List]
  19 * Bug reports [Issue Tracker]
  20 * Everything less than 140 characters: [@JsKarma] on Twitter
  21
  22
  23
  24 ## When should I use Karma?
  25
  26 * You want to test code in *real* browsers.
  27 * You want to test code in multiple browsers (desktop, mobile,
  28   tablets, etc.).
  29 * You want to execute your tests locally during development.
  30 * You want to execute your tests on a continuous integration server.
  31 * You want to execute your tests on every save.
  32 * You love your terminal.
  33 * You don't want your (testing) life to suck.
  34 * You want to use [Istanbul] to automagically generate coverage
  35   reports.
  36 * You want to use [RequireJS] for your source files.
  37
  38
  39 ## But I still want to use \_insert testing library\_
  40
  41 Karma is not a testing framework, nor an assertion library.
  42 Karma just launches a HTTP server, and generates the test runner HTML file you probably already know from your favourite testing framework.
  43 So for testing purposes you can use pretty much anything you like. There are already plugins for most of the common testing frameworks:
  44
  45 * [Jasmine]
  46 * [Mocha]
  47 * [QUnit]
  48 * and [many others](https://www.npmjs.org/browse/keyword/karma-adapter)
  49
  50 If you can't find an adapter for your favourite framework, don't worry and write your own.
  51 It's not that hard and we are here to help.
  52
  53
  54 ## Which Browsers can I use?
  55
  56 All the major browsers are supported, if you want to know more see the
  57 [browsers] page.
  58
  59
  60 ## Troubleshooting
  61 See [FAQ](https://karma-runner.github.io/0.12/intro/faq.html).
  62
  63
  64 ## I want to use it. Where do I sign?
  65
  66 You don't need to sign anything but here are some resources to help
  67 you to get started...
  68
  69
  70 ### Obligatory Screencast.
  71
  72 Every serious project has a screencast, so here is ours.  Just click
  73 [here] and let the show begin.
  74
  75
  76 ### Installation.
  77
  78 See [installation](https://karma-runner.github.io/0.12/intro/installation.html).
  79
  80
  81 ### Using it.
  82
  83 See [configuration](https://karma-runner.github.io/0.12/intro/configuration.html).
  84
  85
  86 ## This is so great. I want to help.
  87
  88 Please, see
  89 [contributing](https://karma-runner.github.io/0.12/dev/contributing.html).
  90
  91
  92 ## Why did you create this?
  93
  94 Throughout the development of [AngularJS], we've been using [JSTD] for
  95 testing. I really think that JSTD is a great idea. Unfortunately, we
  96 had many problems with JSTD, so we decided to write our own test
  97 runner based on the same idea. We wanted a simple tool just for
  98 executing JavaScript tests that is both stable and fast. That's why we
  99 use the awesome [Socket.io] library and [Node.js].
 100
 101
 102 ## My boss wants a license. So where is it?
 103 [MIT License](./LICENSE)
 104
 105
 106 [AngularJS]: https://angularjs.org/
 107 [JSTD]: https://code.google.com/p/js-test-driver/
 108 [Socket.io]: http://socket.io/
 109 [Node.js]: http://nodejs.org/
 110 [Jasmine]: https://github.com/karma-runner/karma-jasmine
 111 [Mocha]: https://github.com/karma-runner/karma-mocha
 112 [QUnit]: https://github.com/karma-runner/karma-qunit
 113 [here]: https://www.youtube.com/watch?v=MVw8N3hTfCI
 114 [Mailing List]: https://groups.google.com/forum/#!forum/karma-users
 115 [Issue Tracker]: https://github.com/karma-runner/karma/issues
 116 [@JsKarma]: https://twitter.com/JsKarma
 117 [RequireJS]: http://requirejs.org/
 118 [Istanbul]: https://github.com/gotwarlost/istanbul
 119
 120 [browsers]: https://karma-runner.github.io/0.12/config/browsers.html
 121 [documentation]: https://karma-runner.github.io