From 40a01fa781390df544ae7a4c168498c6af2e46a3 Mon Sep 17 00:00:00 2001 From: David Kebler Date: Fri, 15 Sep 2023 10:04:29 -0700 Subject: [PATCH] clarlify build vs deploy --- readme.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index e29c85f..e65caf0 100644 --- a/readme.md +++ b/readme.md @@ -1,11 +1,13 @@ # UCI - Live Documetation in a Container -** A self contained live documenation system for editing and displaying documentation via the browser** +**A self contained live documenation system for editing and displaying documentation via the browser** This repo will build an alpine image complete with a mkdocs-material and vscode servers. ## Deploy +if you are using a prebuilt image then you can deploy per below. Otherwise follow directions for building first + * Copy the deploy directory from this repo to your machine that has docker and docker-compose installed * Make a copy of the .env.example file to .env and edit as needed. * Edit the docker-compose.yml as needed.