Skip to content

Commit

Permalink
Merge pull request #420 from plus-/master
Browse files Browse the repository at this point in the history
Fixed documentation links
  • Loading branch information
dignifiedquire committed Mar 22, 2013
2 parents c32f3e3 + 531e55f commit 6896521
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docs/config/01-configuration-file.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
In order to serve you well, Karma needs to know about your
project. That's done through a configuration file.

For an example configuration, see [test/client/testacular.conf.js]
For an example configuration, see [test/client/karma.conf.js]
which contains most of the options.

This document contains a list of all available options, as well as
Expand Down Expand Up @@ -223,7 +223,7 @@ sometimes you might want to proxy a url that is already taken by Karma.
[test/client/testacular.conf.js]: https://github.com/karma-runner/karma/blob/master/test/client/testacular.conf.js
[test/client/karma.conf.js]: https://github.com/karma-runner/karma/blob/master/test/client/karma.conf.js
[config/files]: files.html
[config/browsers]: browsers.html
[config/preprocessors]: preprocessors.html
Expand Down
2 changes: 1 addition & 1 deletion docs/config/03-browsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ $Env:FIREFOX_BIN = 'c:\Program Files (x86)\Mozilla Firefox 4.0 Beta 6\firefox.ex

## Custom browsers
```javascript
// in the testacular.conf.js
// in the karma.conf.js
browsers = ['/usr/local/bin/custom-browser.sh'];

// from cli
Expand Down
8 changes: 4 additions & 4 deletions docs/intro/02-configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
In order to serve you well, Karma needs to know about your
project. That's done through a configuration file.

For an example file, see [test/client/testacular.conf.js]
For an example file, see [test/client/karma.conf.js]
which contains most of the options.

## Generating the config file
Expand All @@ -15,9 +15,9 @@ $ karma init my.conf.js
```

## Starting Karma
When starting testacular, you can pass a path to the configuration file as an argument.
When starting karma, you can pass a path to the configuration file as an argument.

By default, Karma will look for `testacular.conf.js` in the current directory.
By default, Karma will look for `karma.conf.js` in the current directory.
```bash
# Start Karma using your configuration
$ karma start my.conf.js
Expand All @@ -31,5 +31,5 @@ overrides the configuration from the config file.
Try `karma start --help` if you want to see all available options.


[test/client/testacular.conf.js]: https://github.com/karma-runner/karma/blob/master/test/client/testacular.conf.js
[test/client/karma.conf.js]: https://github.com/karma-runner/karma/blob/master/test/client/karma.conf.js
[configuration file docs]: configuration_file.html
10 changes: 5 additions & 5 deletions docs/plus/02-RequireJS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ project/
test/
MyModule.test.js
test-main.js
testacular.conf.js
karma.conf.js
```

### Initialize Karma

Karma comes with a nice utility for generating a config file
(default name: `testacular.conf.js`) that it needs in order to run.
(default name: `karma.conf.js`) that it needs in order to run.

In your terminal, type:
```bash
Expand All @@ -40,13 +40,13 @@ not defined` messages even though it was specified in the ‘shim’
config and required in the test. I could have been doing something
wrong. My solution thus far has been to list each of the non-RequireJs
modules and their dependencies in the `files` attribute of
`testacular.conf.js`.
`karma.conf.js`.

### `testacular.conf.js`
### `karma.conf.js`
The final point is that the RequireJs main module for your test runner
should be the last file listed.

So, finally, here is the ‘file’ excerpt of `testacular.conf.js`:
So, finally, here is the ‘file’ excerpt of `karma.conf.js`:
```javascript
files = [
MOCHA,
Expand Down
2 changes: 1 addition & 1 deletion docs/plus/03-Jenkins-CI.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Optional we highly suggest to install the following Jenkins plug-in:
distributions and user permissions.

## Configure Karma
Make the following additions and changes to your testacular.conf.js
Make the following additions and changes to your karma.conf.js
file as needed:

```javascript
Expand Down
2 changes: 1 addition & 1 deletion docs/plus/05-Cloud9.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Open `http://<projectName>.<cloud9User>.c9.io/` in your browser.
PhantomJS must be installed with `npm install phantomjs`.

### Configure Karma
The `testacular.conf.js` file (tried it out for the [AngularJS foodme app]) must include the following entries:
The `karma.conf.js` file (tried it out for the [AngularJS foodme app]) must include the following entries:

```javascript
browsers = ['PhantomJS'];
Expand Down

0 comments on commit 6896521

Please sign in to comment.