backup/cheerpj-meta
1
0
Fork 0
mirror of https://github.com/leaningtech/cheerpj-meta.git synced 2025-03-15 01:54:48 +01:00
Code Issues Projects Releases Activity

Updated README.md from wiki.

Browse Source
This commit is contained in:
Stefano De Rossi 2017-09-28 11:55:39 +01:00
parent 7c5feb7163
commit 9ba8b4c4e3
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,18 +1,20 @@
# CheerpJ - Java to JavaScript compiler (Beta)
<p align="center"><img src="https://github.com/leaningtech/cheerpj-meta/blob/master/media/cheerpj_logo_whitebg.png" width="300"></p>
<p align="center"><img src="media/cheerpj_logo_whitebg.png" width="300"></p>
# CheerpJ - Java to JavaScript compiler (Beta)
[![Gitter chat](https://badges.gitter.im/leaningtech/cheerpj.svg)](https://badges.gitter.im/leaningtech/cheerpj)
[![GitHub Issues](https://img.shields.io/github/issues/leaningtech/cheerpj-meta.svg)](https://github.com/leaningtech/cheerpj-meta/issues)
[![Live Demos](https://img.shields.io/badge/demo-online-green.svg)](https://leaningtech.com/cheerpj/demos/)
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 documentation link: <https://github.com/leaningtech/cheerpj-meta/wiki>
Main project link: <http://www.leaningtech.com/cheerpj>
What is CheerpJ?
------
<p align="center"><img src="https://leaningtech.com/cheerpj/images/cheerpj_visual_2.png" width="450"></p>
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.
@ -26,12 +28,21 @@ What is unique about CheerpJ?
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.
Getting Started
-------
You can download CheerpJ beta for Linux, Windows and macOS at this address:
https://leaningtech.com/cheerpj/download/noncommercial/
To get started with CheerpJ, please refer to the following pages:
1. [Getting Started](Getting-Started)
2. [Command Line Options](Command-Line-Options)
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 also get in touch via our [mailing list][mail] or via the IRC channel
\#plasma-umass on Freenode.
You can find more information on CheerpJ in the [Documentation](https://github.com/leaningtech/cheerpj-meta/wiki) page.
[mail]: https://groups.google.com/forum/#!forum/cheerpj-developers