Skip to content

Commit

Permalink
Merge pull request #546 from pra85/patch-2
Browse files Browse the repository at this point in the history
Cosmetic changes to Readme
  • Loading branch information
phillipj committed Feb 13, 2016
2 parents e1997ee + 6e42494 commit 3a97339
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ Set Delimiter tags start with an equals sign and change the tag delimiters from

Consider the following contrived example:

```
```html+erb
* {{ default_tags }}
{{=<% %>=}}
* <% erb_style_tags %>
Expand Down Expand Up @@ -515,30 +515,30 @@ mustache.js may be built specifically for several different client libraries, in
- [qooxdoo](http://qooxdoo.org/)

These may be built using [Rake](http://rake.rubyforge.org/) and one of the following commands:

$ rake jquery
$ rake mootools
$ rake dojo
$ rake yui3
$ rake qooxdoo

```bash
$ rake jquery
$ rake mootools
$ rake dojo
$ rake yui3
$ rake qooxdoo
```
## Testing

In order to run the tests you'll need to install [node](http://nodejs.org/).

You also need to install the sub module containing [Mustache specifications](http://github.com/mustache/spec) in the project root.

$ git submodule init
$ git submodule update

```bash
$ git submodule init
$ git submodule update
```
Install dependencies.

$ npm install

```bash
$ npm install
```
Then run the tests.

$ npm test

```bash
$ npm test
```
The test suite consists of both unit and integration tests. If a template isn't rendering correctly for you, you can make a test for it by doing the following:

1. Create a template file named `mytest.mustache` in the `test/_files`
Expand All @@ -550,25 +550,25 @@ The test suite consists of both unit and integration tests. If a template isn't
directory.

Then, you can run the test with:

$ TEST=mytest npm run test-render

```bash
$ TEST=mytest npm run test-render
```
### Browser tests

Browser tests are not included in `npm test` as they run for too long, although they are ran automatically on Travis when merged into master. Run browser tests locally in any browser:

$ npm run test-browser-local

```bash
$ npm run test-browser-local
```
then point your browser to `http://localhost:8080/__zuul`

### Troubleshooting

#### npm install fails

Ensure to have a recent version of npm installed. While developing this project requires npm with support for `^` version ranges.

$ npm install -g npm

```bash
$ npm install -g npm
```
## Thanks

mustache.js wouldn't kick ass if it weren't for these fine souls:
Expand Down

0 comments on commit 3a97339

Please sign in to comment.