diff --git a/README b/README deleted file mode 100644 index 3632eb8..0000000 --- a/README +++ /dev/null @@ -1,13 +0,0 @@ -mal sends mail to one or more recipients, through information passed -on its command line. Read COPYING for information on redistribution. - -* Building - -With ldc and libcurl installed, run: - - $ make - # make install # to install - -Documentation is provided in the man page. - -Written by Jeremy Baxter diff --git a/README.md b/README.md new file mode 100644 index 0000000..bd38d64 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +mal sends email to one or more recipients, through information passed +on its command line. Read COPYING for information on redistribution. + +## compilation + +Install ldc and libcurl, and run `make`. +To install, run `make install` after compiling. + +## documentation + +All documentation is provided in the man page. With mal installed, run +`man mal`, or in this source tree run `man ./mal.1`. Usage examples are +in the **EXAMPLES** section near the end.