diff --git a/Viewer/doc/NOTES b/Viewer/doc/NOTES index 32e356bb..90904232 100755 --- a/Viewer/doc/NOTES +++ b/Viewer/doc/NOTES @@ -1,4 +1,18 @@ + +Initial build +============= + +The `Makefile` handles all the dependencies in all cases but the first run +on a clean system can take a while because `make` uses `npx` to bootstrap +the required apps/libs. + +It is recommended for a clean setup to either run make twice or run an +`npm install` first, this needs to be done to avoid version leaking from +the bootstrapped or global node packages to the build as defined by `package.json` + + + Version numbers =============== @@ -6,6 +20,7 @@ The app version number is automatically synced between package.json (primary) and version.js, all version changes should be made in the former. + Debugging startup errors ======================== @@ -27,6 +42,7 @@ Common reasons for failure on startup: overridden by calling .ready() + Modules and RequireJS ===================== @@ -65,6 +81,7 @@ This seems a bit confusing, so at least the naming convention should be revised. + Entry points ============