docs: simplify repository setup steps (#3478)

Use `npm` scripts instead of shell commands and Grunt.
karma-runner · Apr 20, 2020 · b52333d · b52333d
1 parent 652e24e
commit b52333d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/docs/dev/02-making-changes.md b/docs/dev/02-making-changes.md
@@ -23,11 +23,12 @@ Here are some tips on how to set up a Karma workspace and how to send a good pul
 * Install for development. Use a recent npm version, ignore peerdep warnings
   ```bash
   $ npm install
-  $ rm -rf node_modules/karma
-  $ cd node_modules
-  $ ln -s ../ karma
-  $ cd ../
-  $ grunt browserify
+
+  $ npm run init
+  # or if you're on Windows
+  $ npm run init:windows
+
+  $ npm run build
   ```
 
 ## Testing and Building
@@ -49,7 +50,7 @@ Here are some tips on how to set up a Karma workspace and how to send a good pul
 
 - Build the client code via:
   ```bash
-  $ npm build
+  $ npm run build
   ```
 
 ## Changing the Code

diff --git a/test/client/karma.conf.js b/test/client/karma.conf.js
@@ -57,11 +57,12 @@ fs.lstat('node_modules/karma', (err, stats) => {
   console.log('**** Incorrect directory layout for karma self-tests ****')
   console.log(`
     $ npm install
-    $ rm -rf node_modules/karma
-    $ cd node_modules
-    $ ln -s ../ karma
-    $ cd ../
-    $ grunt browserify
+    
+    $ npm run init
+    # or if you're on Windows
+    $ npm run init:windows
+    
+    $ npm run build
   `)
   process.exit(1)
 })