]> git.donarmstrong.com Git - deb_pkgs/scowl.git/blob - README
Merge tag 'upstream/2015.08.24'
[deb_pkgs/scowl.git] / README
1 Spell Checking Oriented Word Lists (SCOWL)
2 Version 2015.08.24
3 Mon Aug 24 16:39:36 2015 -0400 [39cf19d]
4 by Kevin Atkinson (kevina@gnu.org)
5
6 The SCOWL is a collection of word lists split up in various sizes, and
7 other categories, intended to be suitable for use in spell checkers.
8 However, I am sure it will have numerous other uses as well.
9
10 The latest version can be found at http://wordlist.aspell.net/.
11
12 The directory final/ contains the actual word lists broken up into
13 various sizes and categories.  The r/ directory contains Readmes from
14 the various sources used to create this package.
15
16 The misc/ contains a small list of taboo words, see the README file
17 for more info.  The speller/ directory contains scripts for creating
18 spelling dictionaries for Aspell and Hunspell.
19
20 The other directories contain the necessary information to recreate the
21 word lists from the raw data.  Unless you are interested in improving the
22 words lists you should not need to worry about what's here.  See the
23 section on recreating the words lists for more information on what's
24 there.
25
26 Except for the special word lists the files follow the following
27 naming convention:
28   <spelling category>-<sub-category>.<size>
29 Where the spelling category is one of
30   english, american, british, british_z, canadian, 
31   variant_1, variant_2, variant_3,
32   british_variant_1, british_variant_2,
33   canadian_variant_1, canadian_variant_2,
34 Sub-category is one of
35   abbreviations, contractions, proper-names, upper, words
36 And size is one of
37   10, 20, 35 (small), 40, 50 (medium), 55, 60, 70 (large), 
38   80 (huge), 95 (insane)
39 The special word lists follow are in the following format:
40   special-<description>.<size>
41 Where description is one of:
42   roman-numerals, hacker
43
44 The perl script "mk-list" can be used to create a word list of the
45 desired size, its usage is:
46   ./mk-list [-f] [-v#] <spelling categories> <size>
47 where <spelling categories> is one of the above spelling categories
48 (the english and special categories are automatically included as well
49 as all sub-categories) and <size> is the desired size.  The
50 "-v" option can be used to also include the appropriate
51 variants file up to level '#'.  The normal output will be a sorted
52 word list.  If you rather see what files will be included, use the
53 "-f" option.
54
55 When manually combining the words lists the "english" spelling
56 category should be used as well as one of "american", "british",
57 "british_z" (british with ize spelling), or "canadian".  Great care
58 has been taken so that only one spelling for any particular word
59 is included in the main list (with some minor exceptions).  When two
60 variants were considered equal I randomly picked one for inclusion in
61 the main word list.  Unfortunately this means that my choice in how to
62 spell a word may not match your choice.  If this is the case you can
63 try including one of the "variant_1" spelling categories which
64 includes most variants which are considered almost equal.  The
65 "variant_1" spelling category corresponds mostly to American variants,
66 while the "british_variant_1" and "canadian_variant_1" are for British
67 and Canadian variants, respectively.  The "variant_2" spelling
68 categories include variants which are also generally considered
69 acceptable, and "variant_3" contains variants which are seldom used
70 and may not even be considered correct.  There is no
71 "british_variant_3" or "canadian_variant_3" spelling category since
72 the distinction would be almost meaningless.
73
74 The "abbreviation" category includes abbreviations and acronyms which
75 are not also normal words. The "contractions" category should be self
76 explanatory. The "upper" category includes upper case words and proper
77 names which are common enough to appear in a typical dictionary. The
78 "proper-names" category includes all the additional uppercase words.
79 Finally the "words" category contains all the normal English words.
80
81 To give you an idea of what the words in the various sizes look like
82 here is a sample of 25 random words found only in that size:
83
84 10: agreement analysis anyplace associated command covers danger domain
85     established fairly falls gasoline generally hiding implement improving
86     obvious origin partially proof prospect publication shop threat welcomes 
87
88 20: apologizing approximation arc catalogs debates defend deserted graduated
89     harmony humane interacted interviewed lightninged marker merge passion
90     questionnaire radical sentient signatures strips stupidity timer
91     undergone weaknesses 
92
93 35: absurdity afar blinkers chairperson colloquial curvature effusive
94     ejecting hoards investor kickback lapsed monstrous outstripped oxidation
95     pointlessly pores reveler reverberation seclude tanked tasseling
96     terminators uncovered understatement 
97
98 40: activism aphrodisiacs apocalypse approbations assholes baa checkmate
99     collectibles commentated defection deforestation elates euphemistic
100     flubbed gunrunners platefuls procreated resonate saxes seminal shortcut
101     stripteasing unfairness upstage yep 
102
103 50: agilely antipodes bandoleers boasters complainant comporting
104     concertmaster counterclaiming dishrag distaff fatalists inconceivably
105     joshed junker marmosets pachyderm reassembling rectifiable selectivity
106     shadowboxing stammerer subjoined tackler unhorsing wacks 
107
108 55: ambulancewoman behaviorist behindhand bookstall cochineal commies
109     commissionaire crabwise craftswoman denationalized eponymous girly plenum
110     racegoers remolded sadhu samosa shorthanded slurry snobbishly
111     turbochargers twilit vaginas waterborne yellowness 
112
113 60: antiquarianism barterers bivalent calciferous cambial cermet
114     collateralize discrepant femininely frolickers fustiness grandnieces
115     noncumulative nonfictional nonparticipants nonredeemable obsolesce
116     overdecorates overexertion reinsertion rewashing tonging unfiltered
117     ungraceful venturousness 
118
119 70: acyl bandoline capote conjunctival disheartenment disprize gyrostatics
120     hylomorphism incoercible martlet monochromatism mucoprotein nympha
121     paraphiliac perichondrium phenazine standoffishness subtypes televisor
122     tramontane trustily tyrannicidal ultramicrometer underusing zootoxin 
123
124 80: angularnesses arrantly busher cornborers cosentient cotehardie
125     deglamorizing erythorbates gefülltefish gramash gunkholing logie
126     lovelornness mousmee murry nielled opisthotonic partitioners quietsome
127     shedhand specificate tacrine unearmarked vavassor veridicous 
128
129 95: amphigean apionol besugo blunnen centriciput comblessness dipleiodoscope
130     friskest galloflavine harpylike insupposable microchiropteran
131     nongeographic nontradition oxygas porcelanite precompelled presubdue
132     receptitious semiliberal sheetwriting thermolyzing trifoliata
133     unsyllogistical zephiran 
134
135
136 And here is a count on the number of words in each spelling category
137 (american + english spelling category):
138
139   Size   Words       Names    Running Total  %
140    10    4,427          13        4,440     0.7
141    20    8,122           0       12,562     1.9
142    35   37,259         222       50,043     7.6
143    40    6,846         491       57,380     8.7
144    50   25,129      18,213      100,722    15.3
145    55    6,509           0      107,231    16.3
146    60   13,895         745      121,871    18.5
147    70   35,634       7,934      165,439    25.2
148    80  144,343      33,371      343,153    52.2
149    95  227,730      86,651      657,534   100.0
150
151
152 (The "Words" column does not include the name count.)
153
154 Size 35 is the recommended small size, 50 the medium and 70 the large.
155 For spell checking I recommend using 60.  Sizes 70 and below contain
156 words found in most dictionaries while the 80 size contains all the
157 strange and unusual words people like to use in word games such as
158 Scrabble (TM).  While a lot of the words in the 80 size are not
159 used very often, they are all generally considered valid words in the
160 English language.  The 95 contains just about every English word in
161 existence and then some.  Many of the words at the 95 level will
162 probably not be considered valid English words by most people.  I use
163 the 60 size for the English dictionary for Aspell, and I don't
164 recommend anyone use levels above 70 for spell checking.  Levels above
165 70 contain rarely used words which can hide misspellings of similar
166 more commonly used words.  For example the word "ort" can hide a
167 common typo of "or".  No one should need to use a size larger than 80,
168 the 95 size is labeled insane for a reason.
169
170 Accents are present on certain words such as café in iso8859-1 format.
171
172 CHANGES:
173
174 From Version 2015.05.18 to 2015.08.24 (Aug 24, 2015)
175
176   Various new words.
177
178 From Version 2015.04.24 to 2015.05.18 (May 18, 2015)
179
180   Added some new words found to have a high frequency in the COCA
181   corpus.  (http://corpus.byu.edu/coca/).
182
183   Fix en spelling suggestions for 'alot' and 'exersize' in hunspell
184   dictionary (upstreamed from the changes made in Firefox).
185
186 From Version 2015.02.15 to 2015.04.24 (April 24, 2015)
187
188   Added some new words.
189
190   Convert hunspell dictionary to UTF-8 in order to handle smart
191   quotes correctly.
192
193 From Version 2015.01.28 to 2015.02.15 (February 15, 2015)
194
195   Added a large number of neologisms (newly invented words)
196   such as "selfie" and "smartwatch" thanks to Alan Beale.
197
198   Various other new words.
199
200   Clean up the special-hacker category by removing some words that
201   didn't exist in the Google Book's Corpus (1980 - 2008) and
202   originated from the "Unofficial Jargon File Word Lists".
203
204 From Version 2014.11.17 to 2015.01.28 (January 28, 2015)
205
206   Various new words, many from analyzing the Google Book's Corpus
207   (1980 - 2008).  See http://app.aspell.net/lookup-freq.
208
209   Moved some uncommon words that can easily hide a misspelling of a
210   more common word to level 70.  (calender, adrenalin and Joesph)
211
212   Removed several -er and -est forms from adjectives that were so
213   uncommon that they were not found anywhere is the Google Book's
214   Corpus (1980 - 2008).
215
216 From Version 2014.08.11.1 to 2014.11.17 (November 17, 2014)
217
218   Various new words.
219
220   Fix typo in Hunspell readme.
221
222 From Version 2014.08.11 to 2014.08.11.1 (August 13, 2014)
223
224   Forgot to mention this important change from 7.1 to 2014.08.11:
225
226     Shifted the variant levels up by one: variant_0 is now variant_1,
227     variant_1 is now variant_2, and variant_2 is now variant_3.
228
229   Other minor fixes in this README.
230
231   No changes to the contents of the lists.
232
233 From Revision 7.1 to Version 2014.08.11 (August 11, 2014)
234
235   Added some missing possessive forms.
236
237   Added some new words and proper names.
238
239   Clean up the categories (words, upper, proper-names etc) so that they
240   are more accurate.
241
242   Convert documentation to UTF-8.  For now, the wordlist are still in
243   ISO-8859-1 to prevent compatibility problems.
244
245   Add schema and scripts for creating a SQLite database from SCOWL.
246   Add some utility and library functions using them.  This database is
247   used by the new web app's (http://app.aspel.net/lookup & create).
248
249   Enhance speller/make-hunspell-dict.  The biggest improvement is that
250   it that it now generates several more dictionaries in addition to
251   the official ones.  These additional dictionaries are ones for
252   British English and larger dictionaries that include up to SCOWL
253   size 70.
254
255 From Revision 7 to 7.1 (January 6, 2011)
256
257   Updated to revision 5.1 of Varcon which corrected several errors.
258
259   Fixed various problems with the variant processing which corrected a
260   few more errors.
261
262   Added several now common proper names and some other words now
263   in common use.
264
265   Include misc/ and speller/ directory which were in SVN but left
266   out of the release tarball.
267
268   Other minor fixes, including some fixes to the taboo word lists.
269
270 From Revision 6 to 7 (December 27, 2010)
271
272   Updated to revision 5.0 of Varcon which corrected many errors,
273   especially in the British and Canadian spelling categories.  Also
274   added new spelling categories for the British and Canadian spelling
275   variants and separated them out from the main variant_* categories.
276   
277   Moved Moby names lists (3897male.nam 4946fema.len 21986na.mes) to 95
278   level since they contain too many errors and rare names.
279
280   Moved frequently class 0 from Brian Kelk's Wordlist from 
281   level 60 to 70, and also filter it with level 80 due to, too many
282   misspellings.
283
284   Many other minor fixes.
285
286 From Revision 5 to 6 (August 10, 2004)
287
288   Updated to version 4.0 of the 12dicts package.
289
290   Included the 3esl, 2of4brif, and 5desk list from the new 12dicts
291   package.  The 3esl was included in the 40 size, the 2of4brif in the
292   55 size and the 5desk in the 70 size.
293
294   Removed the Ispell word list as it was a source of too many errors.
295   This eliminated the 65 size.
296
297   Removed clause 4 from the Ispell copyright with permission of Geoff
298   Kuenning.
299
300   Updated to version 4.1 of VarCon.
301
302   Added the "british_z" spelling category which is British using the
303   "ize" spelling.
304
305 From Revision 4a to 5 (January 3, 2002)
306
307   Added variants that were not really spelling variants (such as
308   forwards) back into the main list.
309
310   Fixed a bug which caused variants of words to incorrectly appear in
311   the non-variant lists.
312
313   Moved rarely used inflections of a word into higher number lists.
314
315 From 7.1
316
317   Shifted the variant levels so that level 0 is now 1, level 1 now 2,
318   and level 2 now 3.
319
320   Added other inflections of a words based on the following criteria
321     If the word is in the base form: only include that word.
322     If the word is in a plural form: include the base word and the plural
323     If the word is a verb form (other than plural):  include all verb forms
324     If the word is an ad* form: include all ad* forms
325     If the word is in a possessive form: also include the non-possessive
326
327   Updated to the latest version of many of the source dictionaries.
328
329   Removed the DEC Word List due to the questionable licence and
330   because removing it will not seriously decrease the quality of SCOWL
331   (there are a few less proper names).  
332
333 From Revision 4 to 4a (April 4, 2001)
334
335   Reran the scripts on a never version of AGID (3a) which fixes a bug
336   which caused some common words to be improperly marked as variants.
337
338 From Revision 3 to 4 (January 28, 2001)
339
340   Split the variant "spelling category" up into 3 different levels.
341   
342   Added words in the Ispell word list at the 65 level.
343
344   Other changes due to using more recent versions of various sources
345   included a more accurate version of AGID thanks to the work of
346   Alan Beale
347
348 From Revision 2 to 3 (August 18, 2000)
349
350   Renamed special-unix-terms to special-hacker and added a large
351   number of commonly used words within the hacker (not cracker)
352   community.
353
354   Added a couple more signature words including "newbie".
355
356   Minor changes due to changes in the inflection database.
357
358 From Revision 1 to 2 (August 5, 2000)
359
360   Moved the male and female name lists from the mwords package and the
361   DEC name lists form the 50 level to the 60 level and moved Alan's
362   name list from the 60 level to the 50 level.  Also added the top
363   1000 male, female, and last names from the 1990 Census report to the
364   50 level.  This reduced the number of names in the 50 level from
365   17,000 to 7,000.
366
367   Added a large number of Uppercase words to the 50 level.
368
369   Properly accented the possessive form of some words.
370
371   Minor other changes due to changes in my raw data files which have
372   not been released yet.  Email if you are interested in these files.
373
374 COPYRIGHT, SOURCES, and CREDITS:
375
376 The collective work is Copyright 2000-2015 by Kevin Atkinson as well
377 as any of the copyrights mentioned below:
378
379   Copyright 2000-2015 by Kevin Atkinson
380
381   Permission to use, copy, modify, distribute and sell these word
382   lists, the associated scripts, the output created from the scripts,
383   and its documentation for any purpose is hereby granted without fee,
384   provided that the above copyright notice appears in all copies and
385   that both that copyright notice and this permission notice appear in
386   supporting documentation. Kevin Atkinson makes no representations
387   about the suitability of this array for any purpose. It is provided
388   "as is" without express or implied warranty.
389
390 Alan Beale <biljir@pobox.com> also deserves special credit as he has,
391 in addition to providing the 12Dicts package and being a major
392 contributor to the ENABLE word list, given me an incredible amount of
393 feedback and created a number of special lists (those found in the
394 Supplement) in order to help improve the overall quality of SCOWL.
395
396 The 10 level includes the 1000 most common English words (according to
397 the Moby (TM) Words II [MWords] package), a subset of the 1000 most
398 common words on the Internet (again, according to Moby Words II), and
399 frequently class 16 from Brian Kelk's "UK English Wordlist
400 with Frequency Classification".
401
402 The MWords package was explicitly placed in the public domain:
403
404     The Moby lexicon project is complete and has
405     been place into the public domain. Use, sell,
406     rework, excerpt and use in any way on any platform.
407
408     Placing this material on internal or public servers is
409     also encouraged. The compiler is not aware of any
410     export restrictions so freely distribute world-wide.
411
412     You can verify the public domain status by contacting
413
414     Grady Ward
415     3449 Martha Ct.
416     Arcata, CA  95521-4884
417
418     grady@netcom.com
419     grady@northcoast.com
420
421 The "UK English Wordlist With Frequency Classification" is also in the
422 Public Domain:
423
424   Date: Sat, 08 Jul 2000 20:27:21 +0100
425   From: Brian Kelk <Brian.Kelk@cl.cam.ac.uk>
426
427   > I was wondering what the copyright status of your "UK English
428   > Wordlist With Frequency Classification" word list as it seems to
429   > be lacking any copyright notice.
430
431   There were many many sources in total, but any text marked
432   "copyright" was avoided. Locally-written documentation was one
433   source. An earlier version of the list resided in a filespace called
434   PUBLIC on the University mainframe, because it was considered public
435   domain.
436
437   Date: Tue, 11 Jul 2000 19:31:34 +0100
438
439   > So are you saying your word list is also in the public domain?
440
441   That is the intention.
442
443 The 20 level includes frequency classes 7-15 from Brian's word list.
444
445 The 35 level includes frequency classes 2-6 and words appearing in at
446 least 11 of 12 dictionaries as indicated in the 12Dicts package.  All
447 words from the 12Dicts package have had likely inflections added via
448 my inflection database.
449
450 The 12Dicts package and Supplement is in the Public Domain.
451
452 The WordNet database, which was used in the creation of the
453 Inflections database, is under the following copyright:
454
455   This software and database is being provided to you, the LICENSEE,
456   by Princeton University under the following license.  By obtaining,
457   using and/or copying this software and database, you agree that you
458   have read, understood, and will comply with these terms and
459   conditions.:
460
461   Permission to use, copy, modify and distribute this software and
462   database and its documentation for any purpose and without fee or
463   royalty is hereby granted, provided that you agree to comply with
464   the following copyright notice and statements, including the
465   disclaimer, and that the same appear on ALL copies of the software,
466   database and documentation, including modifications that you make
467   for internal use or for distribution.
468
469   WordNet 1.6 Copyright 1997 by Princeton University.  All rights
470   reserved.
471
472   THIS SOFTWARE AND DATABASE IS PROVIDED "AS IS" AND PRINCETON
473   UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
474   IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PRINCETON
475   UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCHANT-
476   ABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE
477   LICENSED SOFTWARE, DATABASE OR DOCUMENTATION WILL NOT INFRINGE ANY
478   THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
479
480   The name of Princeton University or Princeton may not be used in
481   advertising or publicity pertaining to distribution of the software
482   and/or database.  Title to copyright in this software, database and
483   any associated documentation shall at all times remain with
484   Princeton University and LICENSEE agrees to preserve same.
485
486 The 40 level includes words from Alan's 3esl list found in version 4.0
487 of his 12dicts package.  Like his other stuff the 3esl list is also in the
488 public domain.
489
490 The 50 level includes Brian's frequency class 1, words appearing
491 in at least 5 of 12 of the dictionaries as indicated in the 12Dicts
492 package, and uppercase words in at least 4 of the previous 12
493 dictionaries.  A decent number of proper names is also included: The
494 top 1000 male, female, and Last names from the 1990 Census report; a
495 list of names sent to me by Alan Beale; and a few names that I added
496 myself.  Finally a small list of abbreviations not commonly found in
497 other word lists is included.
498
499 The name files form the Census report is a government document which I
500 don't think can be copyrighted.
501
502 The file special-jargon.50 uses common.lst and word.lst from the
503 "Unofficial Jargon File Word Lists" which is derived from "The Jargon
504 File".  All of which is in the Public Domain.  This file also contain
505 a few extra UNIX terms which are found in the file "unix-terms" in the
506 special/ directory.
507
508 The 55 level includes words from Alan's 2of4brif list found in version
509 4.0 of his 12dicts package.  Like his other stuff the 2of4brif is also
510 in the public domain.
511
512 The 60 level includes all words appearing in at least 2 of the 12
513 dictionaries as indicated by the 12Dicts package.
514
515 The 70 level includes Brian's frequency class 0 and the 74,550 common
516 dictionary words from the MWords package.  The common dictionary words,
517 like those from the 12Dicts package, have had all likely inflections
518 added.  The 70 level also included the 5desk list from version 4.0 of
519 the 12Dics package which is in the public domain.
520
521 The 80 level includes the ENABLE word list, all the lists in the
522 ENABLE supplement package (except for ABLE), the "UK Advanced Cryptics
523 Dictionary" (UKACD), the list of signature words from the YAWL package,
524 and the 10,196 places list from the MWords package.
525
526 The ENABLE package, mainted by M\Cooper <thegrendel@theriver.com>,
527 is in the Public Domain:
528
529   The ENABLE master word list, WORD.LST, is herewith formally released
530   into the Public Domain. Anyone is free to use it or distribute it in
531   any manner they see fit. No fee or registration is required for its
532   use nor are "contributions" solicited (if you feel you absolutely
533   must contribute something for your own peace of mind, the authors of
534   the ENABLE list ask that you make a donation on their behalf to your
535   favorite charity). This word list is our gift to the Scrabble
536   community, as an alternate to "official" word lists. Game designers
537   may feel free to incorporate the WORD.LST into their games. Please
538   mention the source and credit us as originators of the list. Note
539   that if you, as a game designer, use the WORD.LST in your product,
540   you may still copyright and protect your product, but you may *not*
541   legally copyright or in any way restrict redistribution of the
542   WORD.LST portion of your product. This *may* under law restrict your
543   rights to restrict your users' rights, but that is only fair.
544
545 UKACD, by J Ross Beresford <ross@bryson.demon.co.uk>, is under the
546 following copyright:
547
548   Copyright (c) J Ross Beresford 1993-1999. All Rights Reserved.
549
550   The following restriction is placed on the use of this publication:
551   if The UK Advanced Cryptics Dictionary is used in a software package
552   or redistributed in any form, the copyright notice must be
553   prominently displayed and the text of this document must be included
554   verbatim.
555
556   There are no other restrictions: I would like to see the list
557   distributed as widely as possible.
558
559 The 95 level includes the 354,984 single words, 256,772 compound
560 words, 4,946 female names and the 3,897 male names, and 21,986 names
561 from the MWords package, ABLE.LST from the ENABLE Supplement, and some
562 additional words found in my part-of-speech database that were not
563 found anywhere else.
564
565 Accent information was taken from UKACD.
566
567 My VARCON package was used to create the American, British, and
568 Canadian word list. 
569
570 Since the original word lists used in the VARCON package came
571 from the Ispell distribution they are under the Ispell copyright:
572
573   Copyright 1993, Geoff Kuenning, Granada Hills, CA
574   All rights reserved.
575
576   Redistribution and use in source and binary forms, with or without
577   modification, are permitted provided that the following conditions
578   are met:
579
580   1. Redistributions of source code must retain the above copyright
581      notice, this list of conditions and the following disclaimer.
582   2. Redistributions in binary form must reproduce the above copyright
583      notice, this list of conditions and the following disclaimer in the
584      documentation and/or other materials provided with the distribution.
585   3. All modifications to the source code must be clearly marked as
586      such.  Binary redistributions based on modified source code
587      must be clearly marked as modified versions in the documentation
588      and/or other materials provided with the distribution.
589   (clause 4 removed with permission from Geoff Kuenning)
590   5. The name of Geoff Kuenning may not be used to endorse or promote
591      products derived from this software without specific prior
592      written permission.
593
594   THIS SOFTWARE IS PROVIDED BY GEOFF KUENNING AND CONTRIBUTORS ``AS
595   IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
596   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
597   FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GEOFF
598   KUENNING OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
599   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
600   BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
601   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
602   CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
603   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
604   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
605   POSSIBILITY OF SUCH DAMAGE.
606
607
608 The variant word lists were created from a list of variants found in
609 the 12dicts supplement package as well as a list of variants I created
610 myself.
611
612 The Readmes for the various packages used can be found in the
613 appropriate directory under the r/ directory.
614
615 FUTURE PLANS:
616
617 The process of "sort"s, "comm"s, and Perl scripts to combine the many
618 word lists and separate out the variant information is inexact and
619 error prone.  The whole things needs to be rewritten to deal with
620 words in terms of lemmas.  When the exact lemma is not known a best
621 guess should be made.  I'm not sure what form this should be in.  I
622 originally thought this should be some sort of database, but maybe I
623 should just slurp all that data into memory and process it in one
624 giant perl script.  With the amount of memory available these days (at
625 least 2 GB, often 4 GB or more) this should not really be a problem.
626
627 In addition, there is a very nice frequency analyze of the BNC corpus
628 done by Adam Kilgarriff.  Unlike Brian's word lists the BNC lists
629 include part of speech information.  I plan on somehow using these
630 lists as Adam Kilgarriff has given me the OK to use it in SCOWL.
631 These lists will greatly reduce the problem of inflected forms of a
632 word appearing at different levels due to the part-of-speech
633 information.
634
635 There is frequency information for some other corpus such as COCA
636 (Corpus of Contemporary American English) and ANS (American National
637 Corpus) which I might also be able to use.  The former will require
638 permission, and the latter is of questionable quality.
639
640 RECREATING THE WORD LISTS:
641
642 In order to recreate the word lists you need a modern version of Perl,
643 bash, the traditional set of shell utilities, a system that supports
644 symbolic links, and quite possibly GNU Make.  The easiest way to
645 recreate the word lists is to checkout the corresponding Git version
646 (see the version string at the start of the file) and simply type
647 "make" (see http://wordlist.aspell.net).  You can try to download all
648 the pieces manually, but this method is not no longer tested nor
649 supported.
650
651 The src/ directory contains the numerous scripts used in the creation
652 of the final product. 
653
654 The r/ directory contains the raw data used to create the final
655 product.  If you checkout from Git this directory should be populated
656 automatically for you.  If you insist on doing it the hard way see the
657 README file in the r/ directory for more information.
658
659 The l/ directory contains symbolic links used by the actual scripts.
660
661 Finally, the working/ directory is where all the intermittent files go
662 that are not specific to one source.