summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 76902bc..b660d5d 100644
--- a/README.md
+++ b/README.md
@@ -13,4 +13,14 @@ if you want to contribute there is something to be done:
- theoretical information on GPON
- absent stick information
- quick start
-- absent and new ont \ No newline at end of file
+- absent and new ont
+
+## How to build
+This website uses typescript, so remember to:
+
+- Install node (20)
+- Run npm ci to install all relevant typescript packages
+- Run npm run build to transpile ts to js
+
+Alternatively, you can just run:
+`docker-compose up -d typescript` which will build all the required typescript files for you \ No newline at end of file