diff --git a/AMO-README.md b/AMO-README.md new file mode 100644 index 0000000..02a8514 --- /dev/null +++ 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.