Merge pull request #14 from tweedegolf/expand-readme

Expanded readme to better introduce current state of project.

Author: diondokter

README.md

@@ -1,3 +1,22 @@
+# Rust implementation of PTP
+
+This repository is work in progress for a rust implementation of PTP version 2.1 (IEEE 1588-2019). It is far from complete and not yet usable in any capacity.
+
+## Rust version
+
+For compiling this software we advise using the latest version of cargo/rustc as available through rustup. At time of writing this is `1.58.1`.
+
+## Running with elevated privileges
+
+Because of the use of ports 319 and 320 in the PTP protocol, the code here needs to be run as root. It is best to build the code as a non-root user with
+```
+cargo build
+```
+and then run it as root with
+```
+sudo ./target/debug/ptp
+```
+
 ## PTPd setup for testing
 
 PTPd can be used as a ptp master clock for testing. On Ubuntu, it can be installed with
@@ -8,7 +27,7 @@ You probably wont want to run this continuously as a service, so disable it with
 ```bash
 service ptpd disable
 ```
-Then, to start ptpd, run
+Then, to start ptpd, as root run
 ```bash
 ptpd -n -M -i <INTERFACE>
 ```