From 930a9f4f2304ffe57c28f4c7f6faf42c81559e59 Mon Sep 17 00:00:00 2001 From: Ken Elf Mathieu Sternberg Date: Mon, 29 Jun 2015 18:10:58 -0700 Subject: [PATCH] Better README --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index d0d443b..d9b8717 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# A Javascript1 implementation of Lisp-like cons(), using vectors +# cons-lists + +## A Javascript1 implementation of Lisp-like cons(), using vectors 1Technically, Coffeescript, but it's just Javascript. @@ -44,26 +46,24 @@ the qualifying function. For example, this library does not provide caddddr(), but it can easily be generated: metacadr("caddddr") will return a function to get the data content of the fifth cell. +## Requirements + +* `coffee-script` to compile the library. +* `chai`, `mocha`, `coffeelint`, `mocha-jenkins-reporter` for +development. + +See `package.json` for details. + +## Installation + +`npm install https://github.com/elfsternberg/cons-lists.git` + +## Credits + +Elf M. Sternberg + ## LICENSE AND COPYRIGHT NOTICE: NO WARRANTY GRANTED OR IMPLIED Copyright (c) 2015 Elf M. Sternberg -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -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 OR COPYRIGHT HOLDERS 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. - -- Elf M. Sternberg +Licensed under the MIT License. See the `LICENSE` file for full text.