From b21d7dbf1a3e3fc86b26025ea63951c7908ac747 Mon Sep 17 00:00:00 2001 From: TatriX Date: Tue, 15 Mar 2016 00:05:44 +0300 Subject: [PATCH] Create README.md --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5e54571 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +## What is Parenscript? +Parenscript is a translator from an extended subset of Common Lisp to +JavaScript. Parenscript code can run almost identically on both the +browser (as JavaScript) and server (as Common Lisp). + +Parenscript code is treated the same way as Common Lisp code, making +the full power of Lisp macros available for JavaScript. This provides +a web development environment that is unmatched in its ability to +reduce code duplication and provide advanced metaprogramming +facilities to web developers. + +## Installation +```lisp +(ql:quickload :parenscript) +``` +or download the [latest release](https://common-lisp.net/project/parenscript/release/parenscript-latest.tgz) + +## Documentation +* [Reference Manual](https://common-lisp.net/project/parenscript/reference.html) +* [Tutorial](https://common-lisp.net/project/parenscript/tutorial.html) + +## What's the difference? + +At the same time, Parenscript is different from almost all other +"language X" to JavaScript translators in that it imposes almost no +overhead: + +##### No runtime dependencies + Any piece of Parenscript code is runnable as-is. There are no + JavaScript files to include. + + +##### Native types + Parenscript works entirely with native JavaScript datatypes. There + are no new types introduced, and object prototypes are not + touched. + +##### Native calling convention + Any JavaScript code can be called without the need for + bindings. Likewise, Parenscript can be used to make efficient, + self-contained JavaScript libraries. + +##### Readable code + Parenscript generates concise, formatted, idiomatic JavaScript + code. Identifier names are preserved. This enables seamless + debugging in tools like Firebug. + +##### Efficiency + Parenscript introduces minimal overhead for advanced Common Lisp + features. The generated code is almost as fast as hand-written + JavaScript. + +## Links +* [Web site](http://common-lisp.net/project/parenscript/) +* [Source repository](https://github.com/vsedach/Parenscript) + +## License +BSD (see COPYING file) -- 2.11.4.GIT