javascript duktape javascript-engine

Sami Vaarala d3780c8a56 improve setup check script to include perl and java, and to emit all missing dependencies at the same time		11 years ago
api-testcases	api test case fix to match new fatal prototype	11 years ago
bugs	ditz issue update	11 years ago
doc	change convention for DUK_VERSION so that patch level 99 is used for unofficial snapshots (otherwise forks will have confusing versions)	11 years ago
ecmascript-testcases	fix deep inner function test case to check that deep nesting now works up to 1000 levels	11 years ago
emscripten-testcases	add some trivial emscripten test cases	11 years ago
examples	make duk cmdline default memory limit be high, and use -r to reduce it	11 years ago
licenses	murmurhash2 license	12 years ago
misc	misc util for platform define testing	11 years ago
references	Ecmascript E5 and E5.1 specifications as references (license allows redistribution)	12 years ago
runtests	fix runtests to use the new -r option (instead of -m) with duk cmdline	11 years ago
src	use closure compiler for initjs, for now; print out initjs sizes for comparison	11 years ago
util	improve setup check script to include perl and java, and to emit all missing dependencies at the same time	11 years ago
website	change convention for DUK_VERSION so that patch level 99 is used for unofficial snapshots (otherwise forks will have confusing versions)	11 years ago
.gitignore	add a CLOC report to make_dist.sh, to provide some elementary code metrics	11 years ago
LICENSE.txt	license update (year range)	11 years ago
Makefile	add a CLOC report to make_dist.sh, to provide some elementary code metrics	11 years ago
README.md	README update	11 years ago
README.txt.dist	dist readme trivia	11 years ago
RELEASES.txt	release note update	11 years ago

README.md

Duktape

Introduction

Duktape is an embeddable Javascript engine, with a focus on portability and compact footprint.

Duktape is easy to integrate into a C/C++ project: add duktape.c and duktape.h to your build, and use the Duktape API to call Ecmascript functions from C code and vice versa.

Main features:

Embeddable, portable, compact
Ecmascript E5/E5.1 compliant
Built-in regular expression engine
Built-in Unicode support
Minimal platform dependencies
Combined reference counting and mark-and-sweep garbage collection with finalization
Liberal license

See duktape.org for packaged end-user downloads and documentation.

Have fun!

About this repository

This repository is intended for Duktape developers only, and contains Duktape internals: test cases, internal documentation, sources for the duktape.org web site, etc.

Getting started: end user

When embedding Duktape in your application you should use the packaged source distributables available from duktape.org/download.html.

However, if you really want to use a bleeding edge version:

$ git clone https://github.com/svaarala/duktape.git
$ cd duktape
$ make dist-src

Then use duktape-<version>.tar.xz like a normal source distributable.

Getting started: developing Duktape

If you intend to change Duktape internals, run test cases, etc:

# Install NodeJS and npm
$ sudo apt-get install nodejs npm

# Compile the command line tool ('duk')
$ git clone https://github.com/svaarala/duktape.git
$ cd duktape
$ make

# Run Ecmascript and API testcases
$ make ecmatest
$ make apitest
$ make regfuzztest
$ make underscoretest    # see doc/underscore-status.txt
$ make test262test       # see doc/test262-status.txt
$ make emscriptentest    # see doc/emscripten-status.txt
$ make jsinterpretertest

Note: the repo Makefile is intended for Linux developer use, it is not a multi-platform "end user" Makefile. In particular, the Makefile is not intended to work on e.g. OSX or Windows. The source distributable has more user-friendly Makefile examples, but you should normally simply write your own Makefile when integrating Duktape into your program.

License

See LICENSE.txt.