diff --git a/README.md b/README.md index e2b4ba7a315be75afc5ba49b02da452ce4b4cf55..9aa011e7a86de9f8b9cd74815c74b7a074c1d03b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # NDI Directory Service +## Introduction The NDI Directory (Discovery) Service is a service used to allow NDI devices to discover each other on a corporate network where mDNS is not allowed. It is available from the NDI SDK. I have put this into a Docker container, which is available on [Docker Hub](https://hub.docker.com/r/radialbog9/ndi-directory-service). -By using this container you accept the [NDI SDK license agreement](https://downloads.ndi.tv/SDK/NDI_SDK/NDI%20License%20Agreement.pdf) +By using this container you accept the [NDI SDK license agreement](https://downloads.ndi.tv/SDK/NDI_SDK/NDI%20License%20Agreement.pdf). + +## Building +1. Clone the repo: `git clone https://git.rb9.xyz/TheJoeCoder/ndi-directory-service && cd ndi-directory-service` +2. Download the SDK, either using `./setup.sh`, or by downloading and running the setup script from [NDI's SDK page](https://ndi.video/download-ndi-sdk/). +3. Edit `build.sh` and remove `--push` from the `extra_args=` line to disable pushing to Docker Hub. +4. Build for all architectures using `./build.sh`.