From 952f4f8d47625a90e79765cbdb814dc18abc8d67 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sat, 26 Apr 2014 19:57:22 +0100 Subject: [PATCH] Readme --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d200d0f..99f55b6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -TheJargonFile -============= - The Jargon File +=============== + +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. + +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. + +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 +--------------------------- + +As a Git repository the file isn't all that useful. You can export it as a manpage as follows. + +```bash +python makeJargon.py +sudo install -m 644 man/jargon.1.gz /usr/local/share/man/man1 +``` \ No newline at end of file