Skip to content

Commit

Permalink
Improvements to clarity, structure and markup
Browse files Browse the repository at this point in the history
  • Loading branch information
globalcitizen committed Jul 8, 2014
1 parent f5d19df commit 71504fb
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions 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`:

Expand All @@ -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
```

0 comments on commit 71504fb

Please sign in to comment.