Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add readme section for avahi #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add readme section for avahi #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,34 @@ More information on compilation and development can be found on the
of the project documentation.


Extra
=====
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>'.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be

`NDI SDK dependencies <https://docs.ndi.video/docs/sdk/platform-considerations>`_.

(backticks followed by underscore)



Linux
-----

Linux requires Avahi, which provides network discovery for NDI devices.::

libavahi-common.so.3
libavahi-client.so.3


Ubuntu
^^^^^^

Avahi can be installed on Ubuntu by running:

.. code-block::

sudo apt install avahi-daemon
nocarryr marked this conversation as resolved.
Show resolved Hide resolved
sudo systemctl enable --now avahi-daemon


Usage
*****

Expand Down
Loading