From 2475b40502ae2c77c33e43e7107828daac592aed Mon Sep 17 00:00:00 2001 From: 30hours Date: Sun, 18 Feb 2024 02:26:13 +0000 Subject: [PATCH] Add package instructions to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fb3e120..ca202fb 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ The build environment consists of a docker-compose.yml file running the followin ## Usage +Building the code using the following instructions; + - Install docker and docker-compose on the host machine. - Clone this repository to some directory. - Install SDRplay API to run service on host. @@ -37,9 +39,15 @@ vim config/config.yml ./lib/sdrplay-3.14.0/install_lib.sh sudo docker network create blah2 sudo systemctl enable docker -sudo docker compose up -d +sudo docker compose up -d --build ``` +Alternatively avoid building and use the pre-built Docker packages; + +- In `docker-compose.yml` under service `blah2` change `build: .` to `image: ghcr.io/30hours/blah2:latest`. +- In `docker-compose.yml` under service `blah2_api` change `build: ./api` to `image: ghcr.io/30hours/blah2_api:latest`. +- Run with `sudo docker compose up -d`. + The radar processing output is available on [http://localhost:49152](http://localhost:49152). ## Documentation