Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.16 KB
Raw

roslibjs Build Setup

Grunt is used for building, including concatenating, minimizing, documenting, linting, and testing.

Install Grunt and its Dependencies

  1. Install Node.js for your environment
  2. Install the build task runner, Grunt
$ [sudo] npm install -g grunt
  1. Install the dependencies and build dependencies
$ cd /path/to/roslibjs/
$ [sudo] npm install

Build with Grunt

Before proceeding, please confirm you have installed the dependencies above.

To run the build tasks:

  1. cd /path/to/roslibjs/
  2. grunt build

grunt build will concatenate and minimize the files under src and replace roslib.js and roslib.min.js in the build directory. It will also run the linter and test cases. This is what GH Actions runs when a Pull Request is submitted.

grunt dev will watch for any changes to any of the src/ files and automatically concatenate and minimize the files. This is ideal for those developing as you should only have to run grunt dev once.

grunt doc will rebuild all JSDoc for the project.