Added to readme

This commit is contained in:
Nathan Fisher 2023-03-18 23:51:10 -04:00
parent f7fe0250e1
commit e021671403

View file

@ -21,5 +21,19 @@ make && make install
```
## Usage
Most commonly you would call this program from your shell startup files by adding
`42 &` to `~/.bashrc` or `~/.zshrc`, or whatever file your shell happens to use.
`42 &` to *~/.bashrc* or *~/.zshrc*, or whatever file your shell happens to use.
This will give you a DA quote every time you log in or open a new terminal window.
## Licensing
The code is GPL3. The data files are copyrighted works of Douglas Adams. Since he's
dead, and was an avowed atheist, I have no moral qualms that he has any objection
to my sharing them with this program. Governments may disagree. Such is liff.
## Adding more *cookies*
Unlike the *fortune* program, which parsed specially formatted data files, *42*
places each *cookie* in a plain text file which is simply read and printed to
stdout exactly as it appears in the file. The included files are sequentially
numbered, but this is not strictly required. To add more *cookies* simply type
(or, let's face it, you're going to cut and paste here) each message into it's
own file and drop it into an appropriate directory. 42 will look for a data
directory named (surprise) 42 in $(XDG_DATA_DIRS) if it exists, or else the
default of "/usr/local/share:/usr/share". It will also look in *~/.local/share*.
If multiple data directories are found, it will read from all of them.