Skip to content

Commit

Permalink
Update readme for readability, and extra help
Browse files Browse the repository at this point in the history
  • Loading branch information
dominicschaff committed Nov 11, 2021
1 parent f6af6da commit a34c50e
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,19 @@ The Cube in a Box is a simple way to run the [Open Data Cube](https://www.openda
## How to use:

### 1. Setup:
_First time users of Docker should run:_

**Checkout the Repo:**
> `git clone https://github.com/opendatacube/cube-in-a-box.git` or `git clone [email protected]:opendatacube/cube-in-a-box.git`
**First time users of Docker should run:**
* `bash setup.sh` - This will get your system running and install everything you need.
* Note that after this step you will either need to logout/login, or run the next step with `sudo`

*If you already have `make` , `docker` and `docker-compose` installed*
**If you already have `make` , `docker` and `docker-compose` installed. For a custom bounding box append `BBOX=<left>,<bottom>,<right>,<top>` to the end of the command.**
* `make setup` or `make setup-prod` (for speed)
* Custom bounding box: `make setup BBOX=-2,37,15,47` or `make setup-prod BBOX=-2,37,15,47`

*If you do not have `make` installed and would rather run the commands individually run the following:*
**If you do not have `make` installed and would rather run the commands individually run the following:**

* Build a local environment: `docker-compose build`
* Start a local environment: `docker-compose up`
Expand Down

0 comments on commit a34c50e

Please sign in to comment.