From 2b5bfbb72419264669c3e05e59abbd8a0fd2df04 Mon Sep 17 00:00:00 2001 From: Alex Zenla Date: Tue, 7 Feb 2023 12:11:50 -0500 Subject: [PATCH] Add basic docs for Docker. --- tools/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tools/README.md b/tools/README.md index b87161c04f..647c758445 100644 --- a/tools/README.md +++ b/tools/README.md @@ -37,7 +37,14 @@ Then you can either use pip or setuptools. 2. Run `bash pip_install.sh` or `pip_install.bat` (windows) from the following directory digitalbuildings/tools. +### Docker +1. Install [Docker Desktop](https://docs.docker.com/desktop/) +2. Run `./tools/docker_run.sh` to build the docker image. +3. All tools can now be called by passing the tool name and arguments to `./tools/docker_run.sh`, for example, to run ABEL: +``` +$ ./tools/docker_run.sh abel +``` ### Setup (to be deprecated)