github
/
duktape
mirror of https://github.com/svaarala/duktape.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
2330 Commits
65 Branches
60 Tags
84 MiB
 
 
 
 
 
 
Tree: b106801c5e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b106801c5e'
${ noResults }
Sami Vaarala b106801c5e
api test case trivia fix 		11 years ago
api-testcases api test case trivia fix 11 years ago
bugs ditz issue update 11 years ago
doc document SCANBUILD code marker 11 years ago
dukweb use duk_peval() and duk_safe_to_string() in dukweb 11 years ago
ecmascript-testcases test case trivia 11 years ago
emscripten-testcases add some trivial emscripten test cases 11 years ago
examples fix protected/safe call sites in code examples to omit errhandler_index 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 murmurhash2 license 12 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 Ecmascript E5 and E5.1 specifications as references (license allows redistribution) 12 years ago
runtests fix runtests to omit errhandler_index 11 years ago
src api testing for some module helper calls: defining multiple functions and number constants easily from C 11 years ago
util duk_bi_duk.c -> duk_bi_duktape.c 11 years ago
website add logger creation to log write example in guide 11 years ago
xmldoc-testcases commit after local git corruption: build duk/dukd with a valgrind wrapper if requested, remove explicit valgrind tests, trivial xmldoc test 11 years ago
.gitignore dtrace4linux makefile target 11 years ago
AUTHORS.txt osx compile note 11 years ago
CONTRIBUTING.md update README.md and CONTRIBUTING.md with info for reporting bugs (for now) 11 years ago
LICENSE.txt updated copyright model: authors hold copyrights and license under MIT license without copyright assignment 11 years ago
Makefile duk_bi_duk.c -> duk_bi_duktape.c 11 years ago
README.md add branch policy to readme 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.

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.

Copyright and license

See AUTHORS.txt and LICENSE.txt.