readme.mkd

   1 # SquirrelJME
   2
   3 **SquirrelJME** is a Java ME 8 Virtual Machine for embedded and Internet of
   4 Things devices. It has the ultimate goal of being 99.9% compatible with the
   5 Java ME standard.
   6
   7 This project is purely written in Java, with a small secondary C project, and
   8 is very easy to port to different hardware. For running on native hardware, a
   9 compiler handles the conversion of Java byte code to machine code (in an
  10 intermediate format). Any system specific APIs are accessed via standardized
  11 system calls that handle the logic the compiler cannot provide. An execution
  12 engine which is written in C, it offers a lightweight method of code
  13 execution.
  14
  15 Additionally, there is a port of SquirrelJME to RetroArch which enables the
  16 ability to play older J2ME software and games designed for flip-phones.
  17
  18  * Copyright (C) 2013-2024 Stephanie Gawroriski <xer@multiphasicapps.net>
  19  * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2024
  20  * _Lex_ and The _SquirrelJME_ Logo were illustrated by...
  21    * Kat Adam-MacEwen
  22    * Kat@CMYKat Designs & Illustrations <http://www.cmykat-designs.com/>
  23
  24 Please support me on [Patreon](https://www.patreon.com/SquirrelJME)!
  25
  26 Dedicated to _Emily_ (1998-2020), the developer of
  27 [Mu](https://github.com/meepingsnesroms/Mu), you will not be forgotten.
  28 Rest in peace.
  29
  30 Dedicated to _Near_ (1983-2021), the developer of Higan, Ares, etc., may
  31 your soul rest in peace. You will not be forgotten.
  32
  33 _I am currently searching for employment! Check out my_
  34 _[LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)!_
  35
  36 _SquirrelJME_ utilizes _Install4J_ for cross-platform installers, you can
  37 read more about it and check out their product page at:
  38
  39  * [Install4J Multi-Platform Installer Builder](
  40     https://www.ej-technologies.com/products/install4j/overview.html)
  41
  42 Badges:
  43
  44  * _Checks and Quality_
  45    * [![CircleCI](
  46      https://img.shields.io/circleci/build/github/SquirrelJME/SquirrelJME/trunk.svg?label=CircleCI%20Build)](
  47      https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
  48    * [![Code Climate Maintainability](
  49      https://img.shields.io/codeclimate/maintainability-percentage/SquirrelJME/SquirrelJME)](
  50      https://codeclimate.com/github/SquirrelJME/SquirrelJME)
  51      [![Code Climate technical debt](
  52      https://img.shields.io/codeclimate/tech-debt/SquirrelJME/SquirrelJME)](
  53      https://codeclimate.com/github/SquirrelJME/SquirrelJME)
  54    * [![Docker Build](
  55      https://img.shields.io/docker/cloud/build/xerthesquirrel/squirreljme.svg?label=Docker%20Container)](
  56      https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
  57    * [![RetroArch Core](
  58      https://git.libretro.com/libretro/SquirrelJME/badges/trunk/pipeline.svg?key_text=RetroArch%20Core&key_width=115)](
  59      https://git.libretro.org/libretro/SquirrelJME)
  60  * _Social and Community_
  61    * [![Discord](https://img.shields.io/discord/278929900893634560.svg?label=Discord%20Server)](
  62      https://discord.gg/9PkMMKt)
  63    * [![Twitter](
  64      https://img.shields.io/twitter/follow/SquirrelJME.svg?label=Follow%20on%20Twitter)](
  65      https://twitter.com/SquirrelJME)
  66  * _Downloads and Activity_
  67    * ![Commit Activity](
  68      https://img.shields.io/github/commit-activity/w/SquirrelJME/SquirrelJME.svg?label=Code%20Commits)
  69    * [![Docker Pulls](
  70      https://img.shields.io/docker/pulls/xerthesquirrel/squirreljme?label=Docker%20Pulls)](
  71      https://hub.docker.com/r/xerthesquirrel/squirreljme)
  72    * [![SourceForge Downloads](
  73      https://img.shields.io/sourceforge/dm/squirreljme.svg?label=SourceForge%20Downloads)](
  74      https://sourceforge.net/projects/squirreljme/files/)
  75  * _Donations_
  76    * [![Liberapay](
  77      https://img.shields.io/liberapay/receives/xershadowtail.svg?logo=liberapay&label=LiberaPay)](
  78      https://liberapay.com/xershadowtail)
  79
  80 Information:
  81
  82  * [User Guide](assets/user-guide/readme.mkd)
  83  * [Code of Conduct](code-of-conduct.mkd)
  84  * [License](license.mkd)
  85    * _Source_: Mozilla Public License 2.0
  86    * _Assets_: Creative Commons CC-BY-SA 4.0
  87    * _Fonts_ : SIL Open Font License Version 1.1
  88    * [Third Party Licenses](third-party.mkd)
  89  * [Contributing to SquirrelJME](contributing.mkd)
  90    * [Credits of Contributions](credits.mkd)
  91    * [Test Writing](test-writing.mkd)
  92  * _End-User Documents_
  93    * [Building](building.mkd)
  94    * [Changelog](changelog.mkd)
  95    * [Compatibility](compatibility.mkd)
  96    * [History](history.mkd)
  97    * [Release Roadmap](route.mkd)
  98  * _Developer Resources_
  99    * [CircleCI Status](
 100      https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
 101    * [Developer Guide](developer-guide.mkd)
 102    * [Developer Notes](assets/developer-notes/index.mkd)
 103    * [Design Document](design.mkd)
 104    * [Porting SquirrelJME](porting.mkd)
 105    * [Project Scope](scope.mkd)
 106    * [CLDC 1.8 API (docs.oracle.com)](
 107      https://docs.oracle.com/javame/8.0/api/cldc/api/overview-summary.html)
 108
 109 ## Repository
 110
 111  * [Online repository](http://squirreljme.cc/)
 112    ([HTTPS](https://squirreljme.cc/),
 113    [Tor (A)](http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/),
 114    [Tor (B)](http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/))
 115  * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
 116  * The repository may be cloned using Fossil:
 117    * One of these commands:
 118      * `fossil clone -u http://squirreljme.cc/ squirreljme.fossil`
 119      * `fossil clone -u https://squirreljme.cc/ squirreljme.fossil`
 120      * `fossil clone -u http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/ squirreljme.fossil`
 121      * `fossil clone -u http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/ squirreljme.fossil`
 122      * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
 123    * `mkdir squirreljme`
 124    * `cd squirreljme`
 125    * `fossil open ../squirreljme.fossil`
 126  * Alternatively via [GitHub](https://github.com/SquirrelJME/SquirrelJME):
 127    * `git clone https://github.com/SquirrelJME/SquirrelJME`
 128    * `cd SquirrelJME`
 129  * Alternatively via [repo.or.cz](https://repo.or.cz/SquirrelJME.git):
 130    * `git clone https://repo.or.cz/SquirrelJME.git`
 131    * `cd SquirrelJME`
 132  * Trunk Source Snapshot (Main website or `fossil serve` only):
 133    * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
 134    * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
 135
 136 ## Links
 137
 138  * [My Portfolio](https://shadowtail.dev/)
 139  * [My Public PGP Key](public-key.gpg.mkd)
 140  * [SquirrelJME BlueSky](https://bsky.app/profile/squirreljme.bsky.social)
 141  * [SquirrelJME Twitter](https://twitter.com/SquirrelJME)
 142  * [SquirrelJME Mastodon](https://mastodon.online/@SquirrelJME)
 143  * Locations where you can get support:
 144    * [Discord](https://discord.gg/9PkMMKt)
 145    * _LiberaChat (IRC)_ (Bridged to _Discord_)
 146      * [#squirreljme](ircs://irc.libera.chat:6697/squirreljme) -- Main Support
 147      * [#squirreljme-softwares](ircs://irc.libera.chat:6697/squirreljme-software) -- Software channel
 148      * [##squirreljme](ircs://irc.libera.chat:6697/#squirreljme) -- Off-Topic
 149    * [Reddit](https://reddit.com/r/SquirrelJME)
 150  * Front facing social media:
 151    * [BlueSky](https://bsky.app/profile/squirreljme.bsky.social)
 152    * [Mastodon (mastodon.online)](https://mastodon.online/@SquirrelJME)
 153    * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA/)
 154    * [Twitter](https://twitter.com/SquirrelJME)
 155  * [Docker Hub](https://hub.docker.com/r/xerthesquirrel/squirreljme)
 156  * [SourceForge](https://sourceforge.net/p/squirreljme/)
 157  * Personal Accounts (If you wish to contact me this way)
 158    * [GitHub](https://github.com/XerTheSquirrel/)
 159    * [Keybase](https://keybase.io/xerthesquirrel)
 160    * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
 161    * [Mastodon (chitter.xyz)](https://chitter.xyz/@XerShadowTail)
 162    * [BlueSky](https://bsky.app/profile/xershadowtail.bsky.social)
 163    * [Twitter](https://twitter.com/XerShadowTail)
 164    * [Cohost](https://cohost.org/XerShadowTail)
 165    * [YouTube (Personal)](
 166      https://www.youtube.com/channel/UCJ4QrvbDhjtd7u6EpfBQ__g)
 167    * E-Mail: <xer@multiphasicapps.net>
 168
 169 ## Goals
 170
 171  * _To be small_ - Smaller programs are easier to maintain and are usually
 172    simpler.
 173  * _To be fast_ - With the potential of AOT/JIT, systems that do not normally
 174    have a port of an existing virtual machine will usually only have an
 175    interpreter.
 176  * _To be compatible_ - So that existing Java ME 8 applications can run on this
 177    virtual machine, along with J2ME applications when required. This has the
 178    added bonus of allowing one to use older software to catalog for
 179    preservation.
 180  * _To compile once and run anywhere_ - Current and up to date Java
 181    implementations are limited only to a few select systems (_Solaris_,
 182    _Linux_, _BSD_, _Mac OS X_, and _Windows_). Java ME 8 as of this writing
 183    only supports the *FRDM-K64F* (dropped), *STM32429I-EVAL*, *Raspberry Pi*,
 184    *Intel Galileo Gen2* (preview), and *STM 32F746G DISCOVERY* (preview) all
 185    of which are either out of date or discontinued by their manufacturers.
 186    There are multitudes of devices that support **J2ME**, however that is
 187    horribly out of date when compared with the Java that is used today
 188    (**J2ME** is equal to Java 1.4 which was released in _2002_).
 189
 190 ## Donations
 191
 192 You may donate to SquirrelJME to which would be used by the author to keep the
 193 web server online, the purchasing of new hardware/software, and for the
 194 purchasing of food items for consumption.
 195
 196  * Traditional
 197    * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
 198    * [Patreon](https://www.patreon.com/SquirrelJME)
 199    * [Liberapay](https://liberapay.com/xershadowtail)
 200
 201 ## Important Statements
 202
 203 ***JAVA AND ALL OTHER RELATED TRADEMARKS AND COPYRIGHTS ARE OWNED BY ORACLE
 204 CORPORATION <http://www.oracle.com/>.***
 205
 206 ***SQUIRRELJME IS NEITHER PRODUCED BY, ENDORSED BY, NOR SUPPORTED BY
 207 _ORACLE CORPORATION_.***
 208
 209 ***ALL SOURCE CODE IS WRITTEN BY MYSELF WITH FUNCTIONALITY DETERMINED BY THE
 210 DOCUMENTED APIS AND RUN-TIME BEHAVIOR. I HAVE NOT LOOKED AT THE SOURCE CODE FOR
 211 OTHER IMPLEMENTATIONS, NEITHER FREE SOFTWARE NOR PROPRIETARY IMPLEMENTATIONS.
 212 ESSENTIALLY SQUIRRELJME IS A CLEAN-ROOM IMPLEMENTATION OF THE DESIGN OF JAVA
 213 ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8 APIS AND ASSOCIATED JSRS/JEPS IS
 214 CONSIDERED BY MYSELF (STEPHANIE GAWRORISKI) TO BE IN THE FAIR USE.***
 215
 216 ***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
 217 100% COMPATIBLE WITH JAVA ME 8. THERE ARE CURRENTLY NO STABLE RELEASED VERSIONS
 218 OF THIS SOFTWARE. AS SUCH THE FIRST MAJOR VERSION RELEASE WILL BE WHEN IT IS
 219 COMPATIBLE SO AS TO NOT VIOLATE POTENTIAL LICENSES, AND IF POSSIBLE BE VERIFIED
 220 WITH ANY APPLICABLE TCKS (SO IT WOULD BE AN "OFFICIAL" IMPLEMENTATION).***
 221