diff --git a/README.md b/README.md index 1bb3a9d..103bfff 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,21 @@ This is a basic framework for orchestration of the box services for running a fu ## How to use -Either clone this directory into your home directory or copy the files and directories individually. +### Step 1 + +Ensure you have the [latest docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) installed, python3, and docker-compose (installed from python3 pip). + +### Step 2 + +Ensure that your account is permissioned for docker. + +### Step 3 + +Run this from your home directory. This clones this repo into your home directory, as well as preserving the existing structure. + +```bash +curl "https://raw.githubusercontent.com/lncm/thebox-compose-system/master/install-box.sh" | sh +``` +