Update build scripts and instructions

docs/getting_started/installation.md

@@ -1,10 +1,18 @@
 # Installation
 
-PhyloFlow currently supports Linux/MacOS, though a Docker image should be available soon.
+PhyloFlow is currently in development and must be built before running. At
+present we only test support on Linux/MacOS. We hope to make binary builds of
+Phyloflow available through github releases soon (Q3 2023).
 
-To run locally, clone the phyloflow repository and launch:
-`run.sh`
-from the command line.
+Dependencies:
+
+- Python 3.9+
+- [yarn](https://yarnpkg.com/) package manager
+
+To build and run locally, clone the phyloflow repository and launch:
+`build.sh` from the command line. This will build and launch an electron app.
+After the initial build you can launch the by running `run.sh` (this will
+start a virtual environment and launch the app).
 
 Note: You will need to select 'github directory listing' from the Builder drop-down to access modules. Local modules must (currently) be stored in a specific directory structure mirroring the SnakeShack.
 

electron-app/run.sh

@@ -1,14 +1,6 @@
 #!/usr/bin/env bash
 
-# Launches the electron app in development mode
-#  - Connects to frontend server running on localhost:5001
-#  - The front-end can be configured to connect to nodejs (through electron),
-#    or to communicate with a REST API running on localhost:5000
-#  - Backend business logic resides in Python, so this script launches the app
-#    in a virtual environment to communicates with the relevant Python
-#    packages
-#  - Business logic should be ported from Python to nodejs to remove these
-#    dependencies from the app
+# Launches the electron app
 
 set -eoux pipefail
 
@@ -20,12 +12,4 @@ if [ ! -d "venv" ]; then
 fi
 source venv/bin/activate
 
-# compile builderjs
-pushd ../builderjs
-yarn build
-popd
-
-# compile and run
-yarn
-yarn build
-yarn start
+out/PhyloFlow-*/PhyloFlow.app/Contents/MacOS/PhyloFlow

run.sh

@@ -6,6 +6,6 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 pushd $SCRIPT_DIR
 
 cd $SCRIPT_DIR/electron-app
-./run_make.sh
+./run.sh
 
 popd