generator/__tests__/app.js to generator-vfos-io/__tests__/app.js
File was renamed.
generator/generators/app/templates/dummyfile.txt to generator-vfos-io/generators/app/templates/dummyfile.txt
File was renamed.
generator/generators/app/index.js to generator-vfos-io/generators/app/index.js
File was renamed.
generator/swagger/Driver.yaml to generator-vfos-io/swagger/Driver.yaml
File was renamed.
generator/.editorconfig to generator-vfos-io/.editorconfig
File was renamed.
generator/.eslintignore to generator-vfos-io/.eslintignore
File was renamed.
generator/.gitattributes to generator-vfos-io/.gitattributes
File was renamed.
generator/.gitignore to generator-vfos-io/.gitignore
File was renamed.
generator/.travis.yml to generator-vfos-io/.travis.yml
File was renamed.
generator/.yo-rc.json to generator-vfos-io/.yo-rc.json
File was renamed.
generator/LICENSE to generator-vfos-io/LICENSE
File was renamed.
generator/README.md to generator-vfos-io/README.md
--- a/generator/README.md +++ b/generator-vfos-io/README.md @@ -1,37 +1,41 @@ # generator-vfos-io [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] -## Debugging +## Development > vf-OS IO Toolkit Component generator. This generator has been generated using the Yeoman Generator-Generator. If you want to generate the code from scratch, -then install Yeoman and the generator generator: - -npm install -g yo - -(npm install -g generator-generator and run yo generator if you want to generate the generator yourself) - +then install Yeoman and the Loopback generator: +```bash +npm install -g yo generator-loopback +``` The generator source is under the generator folder. The Swagger default Driver and API Connector files are in the Swagger folder. + +## Installation and testing + To test it: Install required dependencies (npm install) -Link the generator so that you can use it from the command window (npm link) -Move to the folder where you want to generate a sample IO component and run the generator (yo vfos-io) - - -## Installation - -First, install [Yeoman](http://yeoman.io) and generator-vfos-io using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). ```bash -npm install -g yo npm install -g generator-vfos-io ``` -Then generate your new project: +CD to the generator folder: +``` +cd generator-vfos-io +``` +Link the generator so that you can use it from the command window + +``` +npm link +``` + +Generate your new project with the yeoman command tool: ```bash yo vfos-io ``` + ## Getting To Know Yeoman
generator/package.json to generator-vfos-io/package.json
File was renamed.