From 0799761ef85d15203142bc61b69526a42b54142a Mon Sep 17 00:00:00 2001 From: Ned Bingham Date: Sat, 24 Sep 2022 18:35:22 -0400 Subject: [PATCH] adding readme --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9551b1a --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Broccoli Development Environment + +Setup the broccoli command line interface with the following command. +``` +source bcli-develop.sh +``` + +Download the developement environment and boot it up in docker +``` +bcli up +``` + +Open up a shell inside the development environment. Here you will have access to all of the necessary tools. +``` +bcli +``` + +Your home directory will be mounted at +``` +/host +``` + +Many of the installed tools may be found at +``` +/opt +``` + +Finally, vim is fully set up for both golang and act +``` +vim file.act +``` + +When you are done, you can shut down the development environment. +``` +bcli down +```