generator-hilary/templates/projects/console/README.md

Yeoman generator for projects that use hilary IoC (DI)

<%= projectName %>
==========

## Getting Started
To install all dependencies, you can execute the ``npm-install-all`` bash script:
```Shell
> sh npm-install-all.sh
```

## Directories
The console app has the following directory structure:
```
- app
- build
    - tasks
- tests
```

The ``app`` directory is where the app code exists, and has a startup file (a composition root) to get you started.

The ``build`` directory has ``grunt`` and ``grunt-mocha-test`` already configured. You can run the tests by navigating to the ``build`` directory and executing ``grunt test``. Grunt tasks are located in the ``tasks`` directory.

The ``tests`` folder is where the test specifications go. This project has ``mocha`` and ``chai`` already configured. The grunt test task will execute any files in the ``tests`` folder that end in ``*.fixture.js``. It will also recurse through a ``tests\specs`` folder, if it exists, where it will execute any files that end in ``*.fixture.js``.