From 38edcb1cd638796a778591d8b7e2a17f752adf1e Mon Sep 17 00:00:00 2001 From: Kait Lam <39479354+katrinafyi@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:15:37 +1000 Subject: [PATCH] readme: direct to deploy readme [no ci] --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 753b71e..4b4c59b 100644 --- a/README.md +++ b/README.md @@ -22,21 +22,15 @@ dune build @install This builds the website to `_build/install/default/lib/aslp_web`. This directory can be uploaded to a static website hosting service. -Note: Although a package.json is present, NPM is _not_ required (or able) to build this project. This is used only for the Cypress E2E tests. It is a design goal to avoid NPM as far as possible. +Note: Although a package.json is present, NPM is _not_ required (or able) to build this project. +This is used only for the Cypress E2E tests. Efforts are made to avoid NPM as far as possible. ## deploy The deployment of the live version of the interface is handled by code in the [`deploy`](https://github.com/katrinafyi/aslp-web/tree/deploy) branch of this repository. - -This contains scripts to reproducibly build multiple versions of the aslp-web interface -(so links to aslp-web output are reproducible and permanent). -This is done by building pinned versions of aslp-web and aslp from the [pac-nix](https://github.com/katrinafyi/pac-nix) -repository. - -The build can be run using `./build.py`. -Deployment is done by GitHub actions using this same script. +See the branch README for more details. ## implementation @@ -58,4 +52,7 @@ without blocking the main UI thread. Currently, there are web workers for the ASLp functionality and the Capstone/Keystone functionality. +Basic end-to-end tests are written using the Cypress framework and +run by GitHub actions on push. +