From 4ab84eb7ca23786db42f0eb471a4db6be8e1da22 Mon Sep 17 00:00:00 2001 From: David Boreham Date: Mon, 23 Jan 2023 07:24:27 -0700 Subject: [PATCH] Enhance readme --- .../cerc-builder-gerbil/README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/app/data/container-build/cerc-builder-gerbil/README.md b/app/data/container-build/cerc-builder-gerbil/README.md index f5cbe601..854139b9 100644 --- a/app/data/container-build/cerc-builder-gerbil/README.md +++ b/app/data/container-build/cerc-builder-gerbil/README.md @@ -1,6 +1,21 @@ ## Gerbil Scheme Builder -This container is designed to be used as a simple "build runner" environment for building and running Scheme projects -using Gerbil and gerbil-ethereum. +This container is designed to be used as a simple "build runner" environment for building and running Scheme projects using Gerbil and gerbil-ethereum. Its primary purpose is to allow build/test/run of gerbil code without the need to install and configure all the necessary prerequisites and dependencies on the host system. +### Usage + +First build the container with: + +``` +$ laconic-so build-containers --include cerc/builder-gerbil +``` + +Now, assuming a gerbil project located at `~/projects/my-project`, run bash in the container mounting the project with: + +``` +$ docker run -it -v $HOME/projects/my-project:/src cerc/builder-gerbil:latest bash +root@7c4124bb09e3:/src# +``` + +Now gerbil commands can be run.