From 6c4ec5c0bd46b1292d15a789560fb5acd813bbce Mon Sep 17 00:00:00 2001 From: Joel Kronqvist Date: Sun, 14 Apr 2024 10:30:26 +0300 Subject: Added installation and `-O3` in Makefile, created manpage and README and licensed under the MIT license --- README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README (limited to 'README') 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` -- cgit v1.2.3