Add dist folder

Niema-Lab · Sep 15, 2023 · 1524f12 · 1524f12
1 parent 3d115f8
commit 1524f12
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 14 deletions.
diff --git a/dist/README.md b/dist/README.md
@@ -0,0 +1,9 @@
+## ViralWasm-Consensus 
+
+A client-side WebAssembly pipeline for viral consensus sequence calling. 
+
+Visit: https://niema-lab.github.io/ViralWasm-Consensus/ to run the pipeline.
+
+To run the pipeline locally without internet, download the **offline** version of ViralWasm-Consensus. To do so, download the latest release / repository (https://github.com/Niema-Lab/ViralWasm-Consensus/archive/master.zip), extract the folder, and click on the `run_website.py` file. Please ensure that you have Python installed. 
+
+Note: When starting the website for the first time offline, you may be prompted with a firewall warning. Click "Allow Access" to run the pipeline.