From 0e85c37a572e7d2d85dfcedc0694d43c59363c63 Mon Sep 17 00:00:00 2001 From: "Jakob L. Kreuze" Date: Fri, 26 Apr 2019 13:19:28 -0400 Subject: Add README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1e5d70 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# brisket + +`brisket` is a primitive newsreader script, capable of fetching posts and +posting to NNTP servers. It's dead simple and lacks any sort of fancy TUI, +opting instead for an interface inspired by the Unix philosophy: posts are read +from stdin, and are written either to stdout or to text files in a directory. + +## Installation + +`brisket` is self-contained and depends only on Hy core and the Python standard +library. Provided that both Hy and Python are installed, you should be able to +invoke `brisket` in the following ways. + +```sh +chmod u+x brisket.hy + +# Install globally. +cp brisket.hy /usr/local/bin/brisket + +# Or + +# I'd rather just run it from the repository. +./brisket.hy +``` + +## Usage + +## Why the name? + +I couldn't come up with a better name, and there's little in the world that +makes me happier than a smoked brisket. + +``` + ________ +< Uhm... > + -------- + \ ^__^ + \ (oo)\\_______ + (__)\\ )\\/\\ + ||----w | + || || +``` -- cgit v1.3