Skip to content

Commit

Permalink
Merge pull request #29 from nekonenene/update_docs
Browse files Browse the repository at this point in the history
Update docs to avoid installing grunt-cli
  • Loading branch information
DanielRuf authored Sep 20, 2020
2 parents 8fce193 + cbe227c commit 4889641
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ If you want to help us translate the documentation into other languages, please
- [Example Jasmine Tests](https://github.com/materializecss/materialize/tree/master/tests/spec)
- [Travis CI](https://travis-ci.org/materializecss/materialize)

Before you start, make sure you install grunt and all its dependencies. To verify you have all the correct dependencies you can run `grunt travis` and it will run the tests. If you get an errors and have not made any changes, it means you have not installed the proper dependencies.
After `npm install`, you can run `npm test` and it will run the tests. If you get any errors and have not made any changes, it means you have not installed the proper dependencies.

Materialize uses Jasmine as the testing framework. We also include a jQuery library which allows you to write tests using jQuery syntax.

Expand Down Expand Up @@ -204,7 +204,7 @@ We also understand that testing CSS properties is pretty tough so you’ll have

1. To only run a specific spec at a time, to avoid wasting your time running all our other tests, you can set the flag `--filter`. For example:
```bash
grunt travis --filter=tabs
npm test -- --filter=tabs
```

This would only run specs with tabs in its name.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ cd materialize
npm install
```

Then run `grunt monitor` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation.
Then run `npm run dev` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation.

### Documentation for previous releases
Previous releases and their documentation are available for [download](https://github.com/materializecss/materialize/releases).
Expand Down

0 comments on commit 4889641

Please sign in to comment.