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.
1472 Commits
65 Branches
60 Tags
84 MiB
 
 
 
 
 
 
Tree: 45bd4c4a4b
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '45bd4c4a4b'
${ noResults }
Sami Vaarala 45bd4c4a4b
refine README.md 		11 years ago
api-testcases add specific negative return api test 11 years ago
bugs ditz issue update 11 years ago
doc add regfuzz to release checklist (currently passes with no valgrind problems) 11 years ago
ecmascript-testcases mark some testcases as 'known bugs' as they won't be fixed in the near future 11 years ago
examples rename __duk__ to Duktape in examples 11 years ago
licenses murmurhash2 license 12 years ago
misc add c overflow misc test 11 years ago
references Ecmascript E5 and E5.1 specifications as references (license allows redistribution) 12 years ago
runtests knownbug marker on failure lines 11 years ago
src downgrade missing locale/language specific caseconv rules from FIXME to XXX (they won't be implemented for a while); remove unnecessary language argument 11 years ago
website remove full distributables from download page, add repo link, README.md trivia 11 years ago
.gitignore add stripped files to ignore too 12 years ago
LICENSE.txt add a basic README and LICENSE 12 years ago
Makefile remove full distributable script, merge Makefile.dist and Makefile to simplify repo use 11 years ago
README.md refine README.md 11 years ago
README.txt.dist remove full dist README, update source dist README 11 years ago
RELEASES.txt release note update 11 years ago
combine_src.py make combining sources deterministic so that combined sources diff better 11 years ago
make_dist.sh add duk_unicode_is_letter 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 test
$ make apitest
$ make regfuzztest

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.