Initial commit

Lts/Tools/ArAssetsV2/readme.md

@@ -0,0 +1,54 @@
+# ArAssetsV2
+
+[Email](mailto:justus.hertel@rheinmetall.com)
+
+## Files & Folders
+
+-   node_modules/\*  
+    Contains the nessecary libraries. Changed only via `npm`
+-   types/\*  
+    Contains typescript definitions (".d.ts") for JS libraries that have not been properly ported to TS yet
+-   tmp/\*  
+    Contains transpiled code. Useless without browserifying it. Gets deleted automatically after build
+-   src/\*  
+    Contains the typescript source files
+-   www/
+    -   img/  
+        Contains images like map markers etc.
+    -   map/\*.jpg  
+        Leaflet map overlays
+    -   map/overlays.json
+        Contains list of leaflet map overlays with name and bounding coordinates
+    -   leaflet.css  
+        Leaflet stylesheet
+    -   main.js  
+        Final transpiled and browserified code
+    -   style.css  
+        Stylesheet for
+    -   index.html  
+        Main page of the app. Also the only page though.
+-   package\*.json  
+    NodeJs stuff. Contains library dependencies and so on. Only changed via `npm`
+-   tsconfig.json  
+    Typescript project configuration
+-   build  
+    Shell script that compiles the app once. Usage: `./build`
+-   watch  
+    Shell script to automatically recompile when chaged. Usage: `./watch`
+-   readme.md  
+    This
+
+## Building/Watching
+
+| Dependency                 | install via           |
+| -------------------------- | --------------------- |
+| Typescript compiler        | `npm i -g tsc`        |
+| Browserify (for `./build`) | `npm i -g browserify` |
+| Uglify (for `--min`)       | `npm i -g uglify-es`  |
+| Watchify (for `./watch`)   | `npm i -g watchify`   |
+
+### build
+
+The build script will transpile (.ts -> .js) and browserify (resolve dependencies) automatically. It also has two command line arguments:
+-   `--min` will minify the output file
+-   `--fetch-deps` will (re)install all node modules