docs: add wip readme for amo

nobkd · Jul 9, 2023 · 1043c6e · 1043c6e
1 parent bd01c1d
commit 1043c6e
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/AMO-README.md b/AMO-README.md
@@ -0,0 +1,22 @@
+# README for AMO
+
+## Prequisites
+
+- Node
+- npm
+
+## Installation
+
+```shell
+npm ci --ignore-scripts
+```
+
+This uses the `package-lock.json` file for installation to avoid package changes and have reproducible builds.
+
+## Building
+
+```shell
+npm run build && npm run bundle
+```
+
+This transpiles and minifies the TypeScript, copies static resources and bundles the output to the `out` directory of the project.