]> git.ipfire.org Git - thirdparty/nqptp.git/commitdiff
Update README.md
authorMike Brady <4265913+mikebrady@users.noreply.github.com>
Mon, 8 Nov 2021 13:18:09 +0000 (13:18 +0000)
committerGitHub <noreply@github.com>
Mon, 8 Nov 2021 13:18:09 +0000 (13:18 +0000)
README.md

index eb0660f1e92d673f25c369be45405c9dfc977985..9fcfe28a880150e7a9556ebaedae88c7defab9e3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -59,20 +59,32 @@ $ make
 ```
 The `make install` installs a `systemd` startup script as requested. You should enable it and start it in the normal way:
 
+### First Install or Update?
+#### First Install
+If you are installing `nqptp` for the first time, enable it and start it:
 ```
 # systemctl enable nqptp
 # systemctl start nqptp
 ```
+If Shairport Sync is already running, you should you restart it after starting `nqptp`:
+```
+# systemctl restart shairport-sync
+```
+#### Update
+If you are updating an existing installation of `nqptp`, after installing it you should restart it. You should then also restart Shairport Sync:
+```
+# systemctl restart nqptp
+# systemctl restart shairport-sync
+```
+# Notes
+Please note that `nqptp` must run in `root` mode to be able to access ports 319 and 320.
 
-Note that `nqptp` must run in `root` mode to be able to access ports 319 and 320.
+Since `nqptp` uses ports 319 and 320, it can not coexist with any other user of those ports, such as full PTP service daemons.
 
-# Notes
 If you wish to use the shared mutex to ensure records are not altered while you are accessing them, you should open your side of the shared memory interface with read-write permission. Be aware that while your program has the mutex lock, it is in a "critical region" where it can halt `nqptp`, so keep any activity while you have the lock very short and very simple, e.g. copying the contents of shared memory to local memory. 
 
 Clock records that are not updated for a period are deleted.
 
-Since `nqptp` uses ports 319 and 320, it can not coexist with any other user of those ports, such as full PTP service daemons.
-
 # Known Issues
 * `nqptp` has not been checked or audited for security issues. Note that it must run in `root` mode.
 * It's probably buggy!