Permalink
Browse files

Add README and UNLICENSE.

  • Loading branch information...
1 parent b06ba21 commit 2f7c6f009e852780022ec90dd8f5548bf3ca00e1 @skeeto committed Mar 3, 2013
Showing with 59 additions and 0 deletions.
  1. +35 −0 README.md
  2. +24 −0 UNLICENSE
View
@@ -0,0 +1,35 @@
+# Fantasy Name Generator
+
+Three implementations -- JavaScript, Elisp, and Perl -- of the
+[name generator described at RinkWorks](http://rinkworks.com/namegen/).
+The JavaScript implementation is by far the most mature.
+
+## JavaScript
+
+The JavaScript version uses an optimizing template-compiler to create
+an efficient generator object.
+
+```javascript
+var generator = NameGen.compile("sV'i");
+generator.toString(); // => "entheu'loaf"
+generator.toString(); // => "honi'munch"
+```
+
+## Emacs Lisp
+
+The Emacs Lisp version doesn't include a parser. It operates on
+s-expressions.
+
+```el
+(fset 'generator (apply-partially #'namegen '(s V "'" i)))
+(generator) ; => "essei'knocker"
+(generator) ; => "tiaoe'nit"
+```
+
+## Perl
+
+The Perl version is exceptionally slow, due to a slow parser.
+
+```perl
+generate("sV'i"); # => "echoi'bum"
+```
View
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

0 comments on commit 2f7c6f0

Please sign in to comment.