]> git.ipfire.org Git - thirdparty/nqptp.git/commitdiff
Update README.md
authorMike Brady <4265913+mikebrady@users.noreply.github.com>
Thu, 8 Jul 2021 13:38:51 +0000 (14:38 +0100)
committerGitHub <noreply@github.com>
Thu, 8 Jul 2021 13:38:51 +0000 (14:38 +0100)
README.md

index 74f6fb3b7e995d7d9278b61dbf159007cebf4c2f..95f61604142adbd12d3d414f59c42672e5eeb8ca 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # NQPTP – Not Quite PTP
-Briefly, `nqptp` monitors timing data from any [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol) clocks – up to 32 – it sees on ports 319 and 320. It maintains records for each clock, identified by Clock ID and IP.
+`nqptp` is a daemon that monitors timing data from any [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol) clocks – up to 32 – it sees on ports 319 and 320. It maintains records for each clock, identified by Clock ID and IP.
 
-A timing peer list can be sent to `nqptp` over port 9000. The list consists of the letter `T` followed by a space-separated list of the IP numbers of the timing peers. The list replaces any existing timing peer list.
+A _timing peer list_ can be sent to `nqptp` over port 9000. The list consists of the letter `T` followed by a space-separated list of the IP numbers of the timing peers. The list replaces any existing timing peer list.
 
 Information about the timing peer list's *master clock* is provided via a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. 
 
@@ -22,6 +22,10 @@ struct shm_structure {
 
 # Installation
 
+This guide is for a recent Linux system with the `systemd` startup system.
+
+As usual, you should ensure everything is up to date.
+
 #### Please use `git`!
 As you probably know, you can download the repository in two ways: (1) using `git` to clone it  -- recommended -- or (2) downloading the repository as a ZIP archive. Please us the `git` method. The reason it that when you use `git`,
 the build process can incorporate the `git` build information in the version string you get when you execute the command `$ nqptp -V`.