Skip to content

Commit

Permalink
remove old docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bates64 committed Oct 4, 2023
1 parent 026d819 commit 514e1a8
Show file tree
Hide file tree
Showing 33 changed files with 68 additions and 1,440 deletions.
27 changes: 0 additions & 27 deletions .github/workflows/rebuildDocs.yml

This file was deleted.

66 changes: 15 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,24 @@
---
title: CheerpJ - Convert Java to WebAssembly and JavaScript
---
<h1><img src="assets/logotype.svg" alt="CheerpJ" height="96"></h1>

[![Gitter chat](https://badges.gitter.im/leaningtech/cheerpj.svg)](https://gitter.im/leaningtech/cheerpj)
[![Discord server](https://img.shields.io/discord/988743885121548329?color=%237289DA&logo=discord&logoColor=ffffff)](https://discord.leaningtech.com)
[![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/demo/?cheerpjfilter)
[![npm](https://img.shields.io/npm/v/cheerpj)](https://npm.im/cheerpj)

CheerpJ is a Java bytecode to WebAssembly and JavaScript compiler, compatible with 100% of Java, which allows to compile any Java SE application, library or Java applet into a WebAssembly/JavaScript application.
CheerpJ is a **drop-in replacement** for the JVM, and is compatible with 100% of Java 8, including Swing, reflection and dynamic class loading.

**Main project link**: <https://leaningtech.com/cheerpj/>
[Documentation](https://labs.leaningtech.com/cheerpj)
[Issues](https://github.com/leaningtech/cheerpj-meta/issues)
[Discord server](https://discord.leaningtech.com)

**Download latest version**: [![Latest version](https://img.shields.io/badge/cheerpj-2.3-green.svg)](https://leaningtech.com/download-cheerpj/) [![Latest version changelog](https://img.shields.io/badge/2.3-changelog-green.svg)](Changelog)
![](assets/cheerpj_visual_2.png)

**Link to latest runtime**: ``https://cjrtnc.leaningtech.com/2.3/loader.js``
With CheerpJ, you can:

If you are unsure how to start, try our [Tutorial](https://docs.leaningtech.com/cheerpj/Tutorial).
- Run existing **Java applications** in the browser with no changes
- Include **Java applets** in webpages without legacy plugins
- Migrate **Java Web Start / JNLP** applications to work on modern systems
- Use Java libraries in JavaScript/TypeScript seamlessly

What is CheerpJ?
------
## Licensing

<p align="center"><img src="assets/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 WebAssembly and 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 comes with a full Java SE runtime, inclusive of Swing/AWT. It supports audio, printing, and any other Java SE component. The runtime supports WebAssembly for optimal performance and size.
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.
6. CheerpJ supports Java multi-threading. In addition, it allows to create concurrent applications by using WebWorkers.

Getting Started
-------

You can download CheerpJ for Linux, Windows and macOS on our website (<https://leaningtech.com/cheerpj/>)

To get started with CheerpJ, please refer to the following pages:
1. [CheerpJ Tutorial](https://docs.leaningtech.com/cheerpj/Tutorial)
2. [Getting Started](https://docs.leaningtech.com/cheerpj/Getting-Started)
3. [Command Line Options](https://docs.leaningtech.com/cheerpj/Command-Line-Options)

Demos
------

Several demos of CheerpJ can be found at <https://leaningtech.com/demo/?cheerpjfilter>.


Bugs and Questions
-------

We welcome any feedback and bug report on it through our [Issue Tracking](https://github.com/leaningtech/cheerpj-meta/issues).

You can also find us on [Gitter](https://gitter.im/leaningtech/cheerpj).
CheerpJ is free for non-commerical use and technical evaluation. See [licensing](https://cheerpj.com/licensing/) for details.
67 changes: 0 additions & 67 deletions _config.yml

This file was deleted.

5 changes: 0 additions & 5 deletions _includes/index-specific.html

This file was deleted.

22 changes: 0 additions & 22 deletions _includes/index.html

This file was deleted.

9 changes: 0 additions & 9 deletions about.md

This file was deleted.

Binary file removed assets/demo_fiddle.png
Binary file not shown.
Binary file removed assets/demo_itext.png
Binary file not shown.
Binary file removed assets/demo_openastex.png
Binary file not shown.
Binary file removed assets/demo_swing.png
Binary file not shown.
53 changes: 53 additions & 0 deletions assets/logotype.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed favicon.ico
Binary file not shown.
1 change: 0 additions & 1 deletion media/1.0-changelog-brightgreen.svg

This file was deleted.

1 change: 0 additions & 1 deletion media/1.1-changelog-brightgreen.svg

This file was deleted.

1 change: 0 additions & 1 deletion media/1.2-changelog-green.svg

This file was deleted.

1 change: 0 additions & 1 deletion media/1.3-changelog-green.svg

This file was deleted.

1 change: 0 additions & 1 deletion media/cheerpj-1.0-brightgreen.svg

This file was deleted.

1 change: 0 additions & 1 deletion media/cheerpj-1.1-brightgreen.svg

This file was deleted.

Loading

0 comments on commit 514e1a8

Please sign in to comment.