From cf54b29fac0cae814f515035773fe793f4f005e3 Mon Sep 17 00:00:00 2001 From: Mike Brady <4265913+mikebrady@users.noreply.github.com> Date: Thu, 8 Jul 2021 12:05:19 +0100 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc18c3a..423e72c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # 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. -Information about the *master clock* is provided in a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. - 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`. + Here are details of the interface: ```c @@ -21,6 +21,19 @@ struct shm_structure { ``` # Installation + +#### 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`. +This will be very useful for identifying the exact build if you are making comments or bug reports. Here is an example: +``` +Version with git build information: +Version: 1.1-dev-24-g0c00a79. Shared Memory Interface Version: 5. + +Version without git build information: +Version: 1.1-dev. Shared Memory Interface Version: 5. +``` +### Build and Install ``` $ git clone git@github.com:mikebrady/nqptp.git $ cd nqptp -- 2.47.2