Add readme section for avahi #13
Conversation
There was a problem hiding this comment.
Thanks for this! I completely forgot about system dependencies.
Would you mind also including a link to the official documentation for other platforms?
Maybe something like
The documentation for other platforms can be found at https://docs.ndi.video/docs/sdk/platform-considerations
|
How's this update? Modified things to be more about the full NDI dependencies, which is a great suggestion! Update: well the README formatting isn't showing correctly in my fork... weird. Perhaps a GH glitch or the |
There was a problem hiding this comment.
Hey, sorry for taking so long. Here are some suggestions for correcting the formatting you're seeing in #13 (comment)
| @@ -99,6 +99,34 @@ More information on compilation and development can be found on the | |||
| of the project documentation. | |||
|
|
|||
|
|
|||
| Extra | |||
| ===== | |||
There was a problem hiding this comment.
The heading level is inconsistent here. It should format correctly to use this instead:
Extra
^^^^^
Linux
"""""
Ubuntu
""""""
|
|
||
| External dependencies might be required for interacting with NDI. View the | ||
| official documentation on | ||
| 'NDI SDK dependencies <https://docs.ndi.video/docs/sdk/platform-considerations>'. |
There was a problem hiding this comment.
This should be
`NDI SDK dependencies <https://docs.ndi.video/docs/sdk/platform-considerations>`_.(backticks followed by underscore)
This only updates the README. I was testing this and wondered why I couldn't find the NDI stream I created. Turns out Linux needs avahi installed. Hope this can help someone else.