diff options
Diffstat (limited to 'js/vendor/angular-ui/README.md')
| -rw-r--r-- | js/vendor/angular-ui/README.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/js/vendor/angular-ui/README.md b/js/vendor/angular-ui/README.md new file mode 100644 index 000000000..0aab44531 --- /dev/null +++ b/js/vendor/angular-ui/README.md @@ -0,0 +1,73 @@ +# AngularUI - The companion suite for AngularJS + +*** + +[](http://travis-ci.org/angular-ui/angular-ui) + +## Usage + +### Requirements + +* **AngularJS v1.0.0+** is currently required. +* **jQuery / Plugins** _(depends on directive)._ Check specific directive dependencies for more information + +## Installation + +The repository comes with the modules pre-built and compressed into the `build/` directory. + +```javascript +angular.module('myApp', ['ui']); +``` + +The modules can be found in the [Directives](https://github.com/angular-ui/angular-ui/tree/master/modules/directives) and [Filters](https://github.com/angular-ui/angular-ui/tree/master/modules/filters) folders. Check out the readme file associated with each module for specific module usage information. + +## Development + +You do not need to build the project to use it - see above - but if you are working on it then this is what you need to know. + +### Requirements + +0. Install [Node.js](http://nodejs.org/) and NPM (should come with) + +1. Install local dependencies: + +```bash +$ npm install +``` + +2. Install global dependencies `grunt`, `coffee-script`, and `testacular`: + +```bash +$ npm install -g testacular coffee-script grunt +``` + +### Build Files & Run Tests + +Before you commit, always run `grunt` to build and test everything once. + +```bash +$ grunt +``` + +### Test & Develop + +The modules come with unit tests that should be run on any changes and certainly before commiting changes to the project. The unit tests should also provide further insight into the usage of the modules. + +First, start the testacular server: +```bash +$ grunt server +``` +Then, open your browser to http://localhost:8080 and run the watch command to re-run tests on every save: +```bash +$ grunt watch +``` + +### Publishing + +For core team: if you wish to publish a new version follow these steps: + +1. Bump the version number inside `package.json` +2. Build and test +3. Commit the updated `package.json` and `build/` folder on their own commit +4. Tag the commit: `git tag v[maj].[min].[patch]` +5. Push the tag: `git push [angular-ui] master --tags`
\ No newline at end of file |