forked from angular/router
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(*): reorganize into different files
- Loading branch information
Showing
3 changed files
with
56 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Contributing | ||
|
||
This doc explains how to build this module yourself | ||
|
||
|
||
## Setup | ||
|
||
1. Install [NodeJS](http://nodejs.org/) | ||
2. Install [Gulp](http://gulpjs.com/) with `npm install -g gulp` | ||
3. Install [Bower](http://bower.io/) with `npm install -g bower` | ||
4. Clone and `cd` into this repo. | ||
5. Install dependencies with `npm install` and `bower install` | ||
|
||
|
||
## Running the Examples | ||
|
||
1. Start the development server with `gulp build watch serve` | ||
2. Open a browser and navigate to [http://localhost:8000/temp/examples/index.html](http://localhost:8000/temp/examples/index.html) | ||
|
||
|
||
## Development | ||
|
||
1. Install [Karma](http://karma-runner.github.io/) with `npm install -g karma` | ||
2. Install the cli for [Karma](http://karma-runner.github.io/) with `npm install -g karma-cli` | ||
3. Start karma with `karma start` | ||
4. Add new tests to the `test` folder. Be sure to give them an extension of `.spec.js`. | ||
|
||
### Code Style Guide | ||
|
||
* Use 2 spaces as tab, see `.editorconfig` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters