From 5427f2e1759205fbba593cceaf4f8895d472ac09 Mon Sep 17 00:00:00 2001 From: Matthijs van der Burgh Date: Tue, 22 Oct 2024 11:59:42 +0200 Subject: [PATCH] Delete CONTRIBUTING.md --- CONTRIBUTING.md | 33 --------------------------------- 1 file changed, 33 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 87e6987f6..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,33 +0,0 @@ -# roslibjs Build Setup - -[Grunt](http://gruntjs.com/) is used for building, including concatenating, minimizing, documenting, linting, and testing. - -## Install Grunt and its Dependencies - - 1. Install [Node.js](http://nodejs.org/) for your environment - 2. Install the build task runner, [Grunt](http://gruntjs.com/) - -```bash -$ [sudo] npm install -g grunt -``` - 3. Install the dependencies and build dependencies - -```bash -$ 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](https://github.com/RobotWebTools/roslibjs/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.