Initial commit of `nedfp` as a front panel for `nedsim`.

[ned1] / nedfp / README.md

diff --git a/nedfp/README.md b/nedfp/README.md
new file mode 100644 (file)
index 0000000..bb871c0
--- /dev/null
+++ b/nedfp/README.md
@@ -0,0 +1,21 @@
+Overview
+========
+
+A passive, graphical front panel for use with `nedsim`.
+
+Status
+======
+
+Functional without restrictions.
+
+Installation
+============
+
+Use `make` and `make clean` to build/remove nedfp files. System installation
+requires manually copying the binary in to place. If a suitable font is not
+already installed, `liberation_mono.ttf`, located in this folder, may be used.
+
+Operation
+=========
+
+Use `nedfp -h` to see current command-line options.