1
0
mirror of https://github.com/leaningtech/cheerpj-meta.git synced 2025-03-15 01:54:48 +01:00
cheerpj-meta/README.md

38 lines
2.4 KiB
Markdown
Raw Normal View History

2017-09-24 17:40:27 +01:00
# CheerpJ - Java to JavaScript compiler (Beta)
<p align="center"><img src="media/cheerpj_logo_whitebg.png" width="300"></p>
CheerpJ is a Java bytecode to JavaScript compiler, compatible with 100% of Java, which allows to compile any Java SE application, library or Java applet into a JavaScript application.
CheerpJ is currently in a private beta stage. If you have not been invited to download the beta yet, don't worry, it will be made available publicly very soon.
In this repository you can find the [documentation](https://github.com/leaningtech/cheerpj-meta/wiki) for CheerpJ, as well as an [issue tracking system](https://github.com/leaningtech/cheerpj-meta/issues) to file your bugs and request features. You can also drop us a line on our [Gitter channel](https://gitter.im/leaningtech/cheerpj).
Main project link: <http://www.leaningtech.com/cheerpj>
What is CheerpJ?
------
CheerpJ is constituted of three components:
1. The CheerpJ AOT compiler, an LLVM-based Java-bytecode to JavaScript compiler. This can be used to convert Java archives (e.g. .jar) or single .class files to JavaScript. The CheerpJ AOT compiler is available for Linux, macOS and Windows.
2. The CheerpJ runtime library, a full Java SE runtime in JavaScript that can be distributed in part or in full with applications converted with CheerpJ.
3. The CheerpJ on-the-fly Java-to-JavaScript compiler, a reduced JavaScript version of the CheerpJ compiler that can be distributed with applications converted with CheerpJ to enable dynamic features of Java such as reflection.
What is unique about CheerpJ?
-------
1. CheerpJ can convert 100% of Java including reflection and proxy class creation, with no manual intervention on the code.
2. CheerpJ works directly on Java bytecode, and does not require access to the Java source code.
3. CheerpJ has a full Java SE runtime, inclusive of Swing/AWT.
4. The JavaScript code generated by CheerpJ is highly optimised and garbage-collectible.
5. CheerpJ enables bidirectional Java-JavaScript interoperability. JavaScript libraries, as well as the DOM, can be called and manipulated from Java. Converted Java modules can be invoked from JavaScript.
Bugs and Questions
-------
CheerpJ is currently in a private beta stage, and we welcome any feedback and bug report on it through our Issue Tracking.
More information
-------
You can find more information on CheerpJ in the [Documentation](https://github.com/leaningtech/cheerpj-meta/wiki) page.