You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Sami Vaarala d88e6571c0 trivial test case fixes related to int coercion return type changes 11 years ago
api-testcases trivial test case fixes related to int coercion return type changes 11 years ago
bugs ditz issue update 11 years ago
doc bithacks link 11 years ago
dukweb dukweb.js now works under Firefox 11 years ago
ecmascript-testcases some tests for __proto__ from web 11 years ago
emscripten-testcases add some trivial emscripten test cases 11 years ago
examples cmdline bug fix: avoid complaining about 'error in reading input' when executing code from a file 11 years ago
jsinterpreter-testcases add a lua.js test case (mandel), add a dir for jsinterpreter testcases, remove emscripten fixup from test case run (should not be needed soon) 11 years ago
licenses commonjs license note 11 years ago
luajs-testcases add a lua.js test case (mandel), add a dir for jsinterpreter testcases, remove emscripten fixup from test case run (should not be needed soon) 11 years ago
misc misc util for platform define testing 11 years ago
references add snapshot of commonjs module specs: they are under the MIT license 11 years ago
runtests fix runtests to omit errhandler_index 11 years ago
src add duk_to_uint(), some improvements to other integer coercion calls (duk_to_uint32() etc) 11 years ago
util add AUTHORS.txt to distributable (it's referenced by LICENSE.txt); embed LICENSE.txt and AUTHORS.txt in an ascii-cleaned-up way into duktape.c and duktape.h 11 years ago
website api doc updates 11 years ago
xmldoc-testcases misc jsonx -> jx renames 11 years ago
.gitignore add .pyc files to gitignore to avoid accidentally adding them to a commit 11 years ago
AUTHORS.txt Merge branch 'master' of https://github.com/svaarala/duktape 11 years ago
CONTRIBUTING.md update contributing: github issues 11 years ago
LICENSE.txt add a license header to make it uniform with AUTHORS.txt when embedded in a .c/.h file 11 years ago
Makefile fixme cleanups 11 years ago
README.md README.md tweak, add getting started link 11 years ago
README.txt.dist dist readme update, eventloop mention 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.

Current branch policy: the "master" branch is used for active development, other branches are frequently rebased feature branches (so you should not fork off them), and tags are used for releases.

Getting started: end user

When embedding Duktape in your application you should use the packaged source distributables available from duktape.org/download.html. See duktape.org/guide.html#gettingstarted for the basics.

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 required packages
$ sudo apt-get install nodejs npm perl openjdk-7-jre

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

# Run Ecmascript and API testcases, and some other tests
$ 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
$ make luajstest
$ make dukwebtest        # then browse to file:///tmp/dukweb-test/dukweb.html
$ make xmldoctest

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.

Reporting bugs

See CONTRIBUTING.md.

Contributing

See CONTRIBUTING.md.

See AUTHORS.txt and LICENSE.txt.