From f26148aea29b7103d2423905a47858a9bcd4da60 Mon Sep 17 00:00:00 2001 From: David Butler Date: Sat, 28 Mar 2020 09:33:31 +0000 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 783afb3..89bc6d6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# jit.ndi -Implementation of NewTek NDI protocol for Cycling 74's Max +LXMax + +Extensions for sending/receiving video and audio using the [Newtek NDI®](https://ndi.tv/) protocol in [Cycling 74's Max](https://cycling74.com/products/max/) + +## Overview + +The [NewTek NDI®](https://ndi.tv/) protocol allows high-quality, high-performance, low-latency streaming of video and audio over a local network. jit.ndi provides a pair of objects to interface this protocol with the Max/Jitter environment, allowing sending/receiving of jitter matrices and MSP signals to/from any other device supporting NDI. + +## Features +- Send/receive 2D jitter matrices of any size. 3-plane RGB and 4-plane RGBA both supported. +- YUV mode for high-performance usage. +- Send/receive unlimited number of audio channels. +- Objects can set/report preview/program tally status on a video source. + +## Requirements +- Max 8 (64-bit) - Windows or Mac +- [Newtek NDI® Runtime](http://new.tk/NDIRedistV4) +- Optional (useful for testing) - [NewTek NDI® Tools](https://ndi.tv/tools/) + +## License +jit.ndi is licensed under LGPL 3.0. This means you are free to use the objects in any commercial/non-commercial project but any changes to the source code must be released under the same license. + +## Installation +Download the package and place in your Max packages folder (`C:/Users/[username]/Documents/Max 8/Packages` on Windows, `/Users/[username]/Documents/Max 8/Packages` on Mac OS). + +## Documentation +Help patchers and Max documentation metadata included in the package. + +## Copyright +jit.ndi Copyright (C) 2020 David Butler / The Impersonal Stereo +www.davidbutlerdesign.co.uk +www.theimpersonalstereo.com + +NDI® is a registered trademark of NewTek, Inc +https://ndi.tv/