Cleanup for the upcoming release

- Moved HowToBuildWebWW.md to a new Building section in README.md - Moved HowToCreateAndRunUnitTests.md to test/README.md - Ordered npm build scripts to group testing commands - Moved and renamed JSDoc configuration files to clarify their purpose - Removed design-notes with the expecation of re-establishing developer focused documentation on the website or wiki. - Closes #258
NASAWorldWind · Nov 8, 2017 · 6a6593e · 6a6593e
1 parent d7f8171
commit 6a6593e
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 131 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -12,7 +12,7 @@ module.exports = function (grunt) {
                 src: ['src'],
                 options: {
                     destination: 'dist/api-doc',
-                    configure: 'config.json',
+                    configure: 'tools/jsdoc.conf.json',
                     readme: 'README.md',
                     recurse: true
                 }

diff --git a/HowToBuildWebWW.md b/HowToBuildWebWW.md
diff --git a/README.md b/README.md
@@ -21,6 +21,20 @@ The Web WorldWind [Developer's Guide](https://webworldwind.org/developers-guide)
 WorldWind's functionality. You'll  also find there links to many Web WorldWind resources, including a user guide. The 
 latest Web WorldWind release provides many simple examples showing how to use all of Web WorldWind's functionality.
 
+## Building
+
+[Install NodeJS](https://nodejs.org/download/). The build is known to work with v6.9.2 (LTS).
+
+- `npm install` downloads WorldWind's dependencies
+
+- `npm run build` builds everything
+
+- `npm run doc` generates the WorldWind API documentation
+
+- `npm run test` runs WorldWind's unit tests
+
+- `npm run test:watch` automatically runs WorldWind's unit tests when source code changes
+
 ## Example Usage
 
 Here is a simple web app using Web WorldWind. It is the contents of SimplestExample.html in the example collection. It 

diff --git a/design-notes/Picking.rtf b/design-notes/Picking.rtf
diff --git a/design-notes/SurfaceShapes.rtf b/design-notes/SurfaceShapes.rtf
diff --git a/package.json b/package.json
@@ -20,8 +20,8 @@
   "scripts": {
     "build": "grunt",
     "clean": "grunt clean",
-    "test": "grunt karma",
     "doc": "grunt jsdoc",
+    "test": "grunt karma",
     "test:watch": "karma start karma.conf.js"
   },
   "files": [

diff --git a/HowToCreateAndRunUnitTests.md → test/README.md b/HowToCreateAndRunUnitTests.md → test/README.md
diff --git a/config.json → tools/jsdoc.conf.json b/config.json → tools/jsdoc.conf.json
@@ -1,7 +1,7 @@
 {
   "templates": {
     "default": {
-      "layoutFile": "./layout.tmpl"
+      "layoutFile": "./jdsoc.layout.tmpl"
     }
   }
 }
diff --git a/layout.tmpl → tools/jsdoc.layout.tmpl b/layout.tmpl → tools/jsdoc.layout.tmpl