add readme

1 files changed, 31 insertions, 1 deletions

diff --git a/README.md b/README.md
index c57f094..80cd59d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
-# snow
+# SNOW
 Super Nifty Olo Webapp - a tool for Platform Evolution engineers
+
+## Configuring
+Some configuration is need on your laptop to make SNOW work.
+
+### Environment Variables
+Add these to your .bashrc:
+`export OLO_PROJECT_HOME=~/jobs/olo/projects  # or wherever you keep your Olo git checkouts
+export OLO_AWS_BUILD_PROFILE=build  # or whatever you call your AWS build profile`
+
+### AWS
+As long as your `~/.aws` directory is in order you should be good to
+go. Make sure you have a valid SSO session.
+
+### tfcloud
+As long as your `~/.terraform.d` directory is in order you should be
+good to go. Make sure you are logged into tfcloud.
+
+### github-cli
+Both the docker build and the app itself rely on a working github-cli.
+
+## Building and Running
+- Navigate to the `ci` top-level directory in a shell.
+- Copy `docker-compose.yaml.example` to `docker-compose.yaml` and
+  customize the bind paths as necessary.
+- Run `./docker-build.sh`
+- Run `./docker-run.sh`
+- Open a web browser and navigate to `http://localhost:3013`. The app
+  takes a bit of time to initialize, so keep trying if it doesn't load
+  immediately.
+