JargonFile/README.md

27 lines
1.3 KiB
Markdown
Raw Normal View History

2014-03-27 14:51:44 -04:00
The Jargon File
2014-04-26 14:57:22 -04:00
===============
Originally created by [Raphael Finkel](http://www.cs.uky.edu/~raphael/), _The Jargon File_ is a list of slang terms used by computer programmers. In recent years the file has fallen into disrepair and much of the language has become dated or irrelevant as fashions, technologies and memes have changed.
2014-04-26 15:25:18 -04:00
I encourage readers to reclaim _The Jargon File_ and make changes, additions or deletions as they see fit. All vaguely sensible pull requests will be considered.
For readability within a Git repository all entries should be plain ASCII text with a maximum of 78 characters across.
2014-04-26 14:57:22 -04:00
This version of _The Jargon File_ was based upon [version 4.4.7 maintained by Eric S. Raymond](http://www.catb.org/jargon/). It was originally imported from HTML via the _importJargon.py_ script within the _import_ subdirectory.
Converting to other formats
---------------------------
2014-04-27 11:21:11 -04:00
As a Git repository the file isn't all that useful. You can export it in other formats as follows:
2014-04-26 14:57:22 -04:00
```bash
2017-03-17 07:09:46 -04:00
python2 makeJargon.py
2014-04-27 11:21:11 -04:00
```
2014-04-27 15:47:08 -04:00
All of the resulting documents can be found in the _docs_ subdirectory. Current formats supported are manpages, HTML and org-mode markup.
2014-04-27 11:21:11 -04:00
To install the manpage:
```bash
sudo install -m 644 docs/jargon.1.gz /usr/local/share/man/man1
```