1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..10484a2
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+
+stdu README
+===========
+
+`stdu` is a program for monitoring the amount of
+input data in real time.
+
+
+Building
+--------
+
+Build the binary `stdu` by running `make`. A
+compiler and standard C libraries are required.
+
+Installation
+------------
+
+Install by either copying/symlinking `stdu` and
+`stdu.1` to the appropriate locations, or run
+`make install`. You can change the installation
+paths by modifying `BINPATH` and `MANPATH` in the
+makefile.
+
+Usage
+-----
+
+See the man page and help message:
+`stdu --help`
+`man stdu`