mirror of https://github.com/konsoletyper/teavm.git synced 2024-12-21 02:19:19 +08:00

Go to file

Steve Hannah b1b602f048 Fixed NPE when padding null arrays to JSO methods that accept arrays.		2017-12-01 19:19:04 +03:00
.idea	Disable nullability inspection in IDEA	2017-11-16 15:11:58 +03:00
all-deps
classlib	Fix bug in base64 encoder	2017-11-26 20:18:39 +03:00
core	Fix compile-time error when callable reference requires boxing	2017-11-26 13:14:02 +03:00
extras-slf4j
html4j	Fix bugs in method resolution in html4j	2017-10-29 21:40:48 +03:00
interop/core	Add support for functions that return true or false depending on whether they run from TeaVM	2017-11-16 18:30:04 +03:00
jso	Fixed NPE when padding null arrays to JSO methods that accept arrays.	2017-12-01 19:19:04 +03:00
metaprogramming	Further bootstrapping	2017-11-26 13:14:02 +03:00
platform	Further bootstrapping	2017-11-26 13:14:02 +03:00
samples	Remove unnecessary .iml file	2017-11-09 22:10:15 +03:00
tests	Add support for several JDK classes and functions	2017-11-26 17:10:56 +03:00
tools	Rename DependencyChecker to DependencyAnalyzer	2017-11-12 23:21:16 +03:00
.gitignore	Update gitignore	2017-11-26 13:14:02 +03:00
.travis.yml
checkstyle.xml	Add support for more java.util.zip	2017-11-10 00:47:48 +03:00
LICENSE
license-regexp.txt
NOTICE
pom.xml	Revive Eclipse plugin	2017-11-09 20:10:15 +03:00
README.md	Update readme	2017-09-28 14:48:48 +03:00
set-version.sh
travis-settings.xml
update-idea-repository.sh

README.md

TeaVM

See documentation at the project web site.

Useful links:

Building TeaVM

Simply clone source code (git clone https://github.com/konsoletyper/teavm.git) and run maven build (mvn clean install). You can do things a little faster (mvn clean -DskipTests) or even a little more faster (mvn clean -DskipTests -Dteavm.build.all=false).

Preview builds

You may want to access new features and don't want to wait until stable release is published on Maven Central. In this case you can get latest development build from bintray. All you need is to put the following in your pom.xml:

  <repositories>
    <repository>
      <id>teavm-dev</id>
      <url>https://dl.bintray.com/konsoletyper/teavm</url>
    </repository>
  </repositories>

IDEA plugin is also available in preview builds. You need to add corresponding repository manually to IDEA. Open Settings -> Plugins -> Browse repositories... -> Manage repositories..., click Add button and enter http://teavm.org/idea/dev/teavmRepository.xml. Then get back to Browse repositories and pick TeaVM plugin from list.

Embedding TeaVM

If you are not satisfied with Maven, you can embed TeaVM in your program or even create your own plugin for any build tool, like Ant or Gradle. The starting point for you may be org.teavm.tooling.TeaVMTool class from teavm-tooling artifact. You may want to go deeper and use org.teavm.vm.TeaVM from teavm-core artifact, learn how TeaVMTool initializes it. To learn how to use TeaVMTool class itself, find its usages across project source code. You most likely encounter Maven and IDEA plugins.

Please, notice that these APIs for embedding are still unstable and may change between versions.

WebAssembly

WebAssembly support is in experimental status. It may lack major features available in JavaScript backend. There's no documentation yet and you should do many things by hands (like embedding generated wasm file into your page, importing JavaScript objects, etc). Look at samples/benchmark module. You should first examine pom.xml file to learn how to build wasm file from Java. Then you may want to examine index-teavm.html and index-teavm.js to learn how to embed WebAssembly into your web page.

Feedback

More information is available at the official site: http://teavm.org.

Ask your questions by email: info@teavm.org. Also you can report issues on a project's issue tracker.