/openrov-grunt-init-plugin

A scaffolding generator for building OpenROV Cockput Plugins

Primary LanguageJavaScript

openrov-grunt-init-plugin

Create plugin scaffolding with grunt-init.

Installation

If you haven't already done so, install grunt-init.

Once grunt-init is installed, place this template in your ~/.grunt-init/ directory. It's recommended that you use git to clone this template into that directory, as follows:

git clone https://github.com/openrov/openrov-grunt-init-plugin.git ~/.grunt-init/openrov-plugin

(Windows users, see the documentation for the correct destination directory path)

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

grunt-init openrov-plugin

Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.

Report all issues in the primary software repository: https://github.com/OpenROV/openrov-software/issues