Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Readme file updated.
  • Loading branch information
tapas4java committed Nov 9, 2014
1 parent 97db317 commit 189e1df
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Features
* All files related to a conceptual unit are placed together. For example, the controller, HTML, LESS, and unit test for a template are placed together in the same directory.
* Provides a ready-made Grunt build that produces an extremely optimized distribution.
* Build uses [grunt-ngmin](https://github.com/btford/grunt-ngmin) so you don't have to use the Angular injection syntax for safe minification (i.e. you dont need `$inject` or `(['$scope','$http',...`.
* `grunt serve` task allows you to run a simple development server with watch/livereload enabled. Additionally, JSHint and the appropriate unit tests are run for the changed files.
* `grunt run` task allows you to run a simple development server with watch/livereload enabled. Additionally, JSHint and the appropriate unit tests are run for the changed files.
* Integrates Bower for package management
* Includes Yeoman subgenerators for directives, services, templates, controllers, filters, and modules.
* Integrates LESS and includes Bootstrap via the source LESS files allowing you to reuse Bootstrap vars/mixins/etc.
* Easily Testable - Each sub-generator creates a skeleton unit test. Unit tests can be run via `grunt test` and they run automatically during the grunt watch that is active during `grunt serve`.
* Easily Testable - Each sub-generator creates a skeleton unit test. Unit tests can be run via `grunt test` and they run automatically during the grunt watch that is active during `grunt run`.

Directory Layout
-------------
Expand Down Expand Up @@ -84,11 +84,12 @@ Grunt Tasks

Now that the project is created, you have 3 simple Grunt commands available:

grunt serve #This will run a development server with watch & livereload enabled.
grunt run #This will run a development server with watch & livereload enabled.
grunt test #Run local unit tests.
grunt e2e #Run protractor end to end(e2e) tests.
grunt build #Places a fully optimized (minified, concatenated, and more) in /dist

When `grunt serve` is running, any changed javascript files will be linted using JSHint as well as have their appropriate unit tests executed. Only the unit tests that correspond to the changed file will be run. This allows for an efficient test driven workflow.
When `grunt run` is running, any changed javascript files will be linted using JSHint as well as have their appropriate unit tests executed. Only the unit tests that correspond to the changed file will be run. This allows for an efficient test driven workflow.

Yeoman Subgenerators
-------------
Expand All @@ -104,15 +105,15 @@ There are generators for `directive`, `template`, `service`, `filter`, `module`,

Running a generator:

yo ng-appgen:directive my-awesome-directive
yo ng-appgen:directive my-directive
yo ng-appgen:template my-template
yo ng-appgen:service my-service
yo ng-appgen:service my-controller
yo ng-appgen:filter my-filter
yo ng-appgen:module my-module
yo ng-appgen:modal my-modal

The name paramater passed (i.e. 'my-awesome-directive') will be used as the file names. The generators will derive appropriate class names from this parameter (ex. 'my-awesome-directive' will convert to a class name of 'MyAwesomeDirective'). Each sub-generator will ask for the folder in which to create the new skeleton files. You may override the default folder for each sub-generator in the `.yo-rc.json` file.
The name paramater passed (i.e. 'my-directive') will be used as the file names. The generators will derive appropriate class names from this parameter (ex. 'my-awesome-directive' will convert to a class name of 'MyAwesomeDirective'). Each sub-generator will ask for the folder in which to create the new skeleton files. You may override the default folder for each sub-generator in the `.yo-rc.json` file.

The modal subgenerator is a convenient shortcut to create templates that work as modals for Bootstrap v3.1 and Angular-UI-Bootstrap v0.10 (both come preconfigured with this generator). If you choose not to use either of these libraries, simply don't use the modal subgenerator.

Expand All @@ -126,7 +127,7 @@ Submodules allow you to more explicitly separate parts of your application. Use
Preconfigured Libraries
-------------

The new app will have a handful of preconfigured libraries included. This includes Angular 1.2, Bootstrap 3, AngularUI Bootstrap, AngularUI Utils, FontAwesome 4, JQuery 2, Underscore 1.5, LESS 1.6, and Moment 2.5. You may of course add to or remove any of these libraries. But the work to integrate them into the app and into the build process has already been done for you.
The new app will have a handful of preconfigured libraries included. This includes Angular 1.3, Bootstrap 3, AngularUI Bootstrap, AngularUI Utils, FontAwesome 4, JQuery 2, Underscore 1.5, LESS 1.6, and Moment 2.5. You may of course add to or remove any of these libraries. But the work to integrate them into the app and into the build process has already been done for you.

Build Process
-------------
Expand Down

0 comments on commit 189e1df

Please sign in to comment.