From 71504fb173c95bf44428ecd5d5976a85454b6dd1 Mon Sep 17 00:00:00 2001 From: Walter Stanish Date: Wed, 9 Jul 2014 05:44:14 +0700 Subject: [PATCH] Improvements to clarity, structure and markup --- README.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 61a91f8..6551142 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,19 @@ TAO (The Art) of Unix Programming (and related systemic epiphanies) =================================================================== -This is a ruby-powered, ANSI-enabled, fortune-like program to espouse wisdom at +This is a ruby-powered, ANSI-enabled, `fortune`-like program to espouse wisdom at opportune moments, such as when you log in. +It's mostly a personal collection, but contributions are welcome. + To get it running, make sure you have `ruby` and `gem` installed, then run: `gem install ansi` After that, it should work fine. -There are two modes other than standard invocation, `--machine` which drops any -ANSI colors from the output, and `--fortune` which converts the wisdom to an -assumed imitation of the fortune format. To make the resulting fortune format -file available to the classic `fortune` program (loses ANSI colors in output) -you can run `strfile` as follows: -``` -taoup --fortune >taoup-fortunes -strfile taoup-fortunes taoup-fortunes.dat -fortune taoup-fortunes -``` +Getting wisdom at login +----------------------- To display `taoup` output at login, try something like this in your `.profile`: @@ -34,3 +28,18 @@ do not copy from Github-webland. The `while read line...done` stuff is an ugly hack for portable random `sort`, mostly for OSX users. If you don't yet have `cowsay`, stop reading right now and get it installed! + +Special modes +------------- + +There are two modes other than standard invocation, `--machine` which drops any +ANSI colors from the output, and `--fortune` which converts the wisdom to an +assumed imitation of the fortune format. To make the resulting fortune format +file available to the classic `fortune` program (loses ANSI colors in output) +you can run `strfile` as follows: + +``` +taoup --fortune >taoup-fortunes +strfile taoup-fortunes taoup-fortunes.dat +fortune taoup-fortunes +```