From 222d2abe01ca2327ba152daf6e0b1d09b1238185 Mon Sep 17 00:00:00 2001 From: Sami Vaarala Date: Tue, 22 Jan 2013 23:31:29 +0200 Subject: [PATCH] add a basic README and LICENSE --- LICENSE.txt | 22 ++++++++++++++++++++++ README.txt | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 LICENSE.txt create mode 100644 README.txt diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..c579a507 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,22 @@ +(http://opensource.org/licenses/MIT) + +Copyright (c) 2013 Sami Vaarala + +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. + diff --git a/README.txt b/README.txt new file mode 100644 index 00000000..c044c55b --- /dev/null +++ b/README.txt @@ -0,0 +1,37 @@ +======= +Duktape +======= + +Duktape is a small and portable Ecmascript E5/E5.1 implementation. +It is intended to be easily embeddable into C programs, with a C API +similar in spirit to Lua's. + +The goal is to support the full E5 feature set like Unicode strings +and Perl 5 -like regular expressions. Other feature highlights: + + * Custom types (like pointers and buffers) for better C integration + + * Reference counting and mark-and-sweep garbage collection, with + finalizer support + + * Co-operative threads, a.k.a. coroutines + + * Tail call support + +For building, see:: + + doc/building.txt + +For an API description for calling code, see:: + + doc/api.txt + +The internal design is described in a bunch of separate documents. +You should begin with the overview in:: + + doc/design.txt + +Duktape is licensed under the MIT license (see ``LICENSE.txt``). + +Have fun! +