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-2022 Stephanie Gawroriski <xer@multiphasicapps.net>
  19  * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2022
  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 Badges:
  34
  35  * _Checks and Quality_
  36    * [![CircleCI](
  37      https://img.shields.io/circleci/build/github/SquirrelJME/SquirrelJME/trunk.svg?label=CircleCI%20Build)](
  38      https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
  39    * [![Code Climate Maintainability](
  40      https://img.shields.io/codeclimate/maintainability-percentage/SquirrelJME/SquirrelJME)](
  41      https://codeclimate.com/github/SquirrelJME/SquirrelJME)
  42      [![Code Climate technical debt](
  43      https://img.shields.io/codeclimate/tech-debt/SquirrelJME/SquirrelJME)](
  44      https://codeclimate.com/github/SquirrelJME/SquirrelJME)
  45    * [![Docker Build](
  46      https://img.shields.io/docker/cloud/build/xerthesquirrel/squirreljme.svg?label=Docker%20Container)](
  47      https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
  48    * [![RetroArch Core](
  49      https://git.libretro.com/libretro/SquirrelJME/badges/trunk/pipeline.svg?key_text=RetroArch%20Core&key_width=115)](
  50      https://git.libretro.org/libretro/SquirrelJME)
  51  * _Social and Community_
  52    * [![Discord](https://img.shields.io/discord/278929900893634560.svg?label=Discord%20Server)](
  53      https://discord.gg/9PkMMKt)
  54    * [![Twitter](
  55      https://img.shields.io/twitter/follow/SquirrelJME.svg?label=Follow%20on%20Twitter)](
  56      https://twitter.com/SquirrelJME)
  57  * _Downloads and Activity_
  58    * ![Commit Activity](
  59      https://img.shields.io/github/commit-activity/w/SquirrelJME/SquirrelJME.svg?label=Code%20Commits)
  60    * [![Docker Pulls](
  61      https://img.shields.io/docker/pulls/xerthesquirrel/squirreljme?label=Docker%20Pulls)](
  62      https://hub.docker.com/r/xerthesquirrel/squirreljme)
  63    * [![SourceForge Downloads](
  64      https://img.shields.io/sourceforge/dm/squirreljme.svg?label=SourceForge%20Downloads)](
  65      https://sourceforge.net/projects/squirreljme/files/)
  66  * _Donations_
  67    * [![Liberapay](
  68      https://img.shields.io/liberapay/receives/xershadowtail.svg?logo=liberapay&label=LiberaPay)](
  69      https://liberapay.com/xershadowtail)
  70
  71 Information:
  72
  73  * [User Guide](assets/user-guide/readme.mkd)
  74  * [Code of Conduct](code-of-conduct.mkd)
  75  * [License](license.mkd)
  76    * _Source_: GNU General Public License, Version 3 or later
  77    * _Assets_: Creative Commons CC-BY-SA 4.0
  78    * _Fonts_ : SIL Open Font License Version 1.1
  79    * [Third Party Licenses](third-party.mkd)
  80  * [Contributing to SquirrelJME](contributing.mkd)
  81    * [Credits of Contributions](credits.mkd)
  82    * [Test Writing](test-writing.mkd)
  83  * _End-User Documents_
  84    * [Building](building.mkd)
  85    * [Changelog](changelog.mkd)
  86    * [Compatibility](compatibility.mkd)
  87    * [History](history.mkd)
  88    * [Release Roadmap](route.mkd)
  89  * _Developer Resources_
  90    * [CircleCI Status](
  91      https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
  92    * [Developer Guide](developer-guide.mkd)
  93    * [Developer Notes](assets/developer-notes/index.mkd)
  94    * [Design Document](design.mkd)
  95    * [Porting SquirrelJME](porting.mkd)
  96    * [Project Scope](scope.mkd)
  97    * [CLDC 1.8 API (docs.oracle.com)](
  98      https://docs.oracle.com/javame/8.0/api/cldc/api/overview-summary.html)
  99
 100 ## Repository
 101
 102  * [Online repository](http://squirreljme.cc/)
 103    ([HTTPS](https://squirreljme.cc/),
 104    [Tor (A)](http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/),
 105    [Tor (B)](http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/))
 106  * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
 107  * The repository may be cloned using Fossil:
 108    * One of these commands:
 109      * `fossil clone -u http://squirreljme.cc/ squirreljme.fossil`
 110      * `fossil clone -u https://squirreljme.cc/ squirreljme.fossil`
 111      * `fossil clone -u http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/ squirreljme.fossil`
 112      * `fossil clone -u http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/ squirreljme.fossil`
 113      * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
 114    * `mkdir squirreljme`
 115    * `cd squirreljme`
 116    * `fossil open ../squirreljme.fossil`
 117  * Alternatively via [GitHub](https://github.com/SquirrelJME/SquirrelJME):
 118    * `git clone https://github.com/SquirrelJME/SquirrelJME`
 119    * `cd SquirrelJME`
 120  * Alternatively via [repo.or.cz](https://repo.or.cz/SquirrelJME.git):
 121    * `git clone https://repo.or.cz/SquirrelJME.git`
 122    * `cd SquirrelJME`
 123  * Trunk Source Snapshot (Main website or `fossil serve` only):
 124    * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
 125    * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
 126
 127 ## Links
 128
 129  * [My Portfolio](https://shadowtail.dev/)
 130  * [My Public PGP Key](public-key.gpg.mkd)
 131  * [SquirrelJME Twitter](https://twitter.com/SquirrelJME)
 132  * [SquirrelJME Mastodon](https://mastodon.online/@SquirrelJME)
 133  * Locations where you can get support:
 134    * [Discord](https://discord.gg/9PkMMKt)
 135    * _LiberaChat (IRC)_ (Bridged to _Discord_)
 136      * [#squirreljme](ircs://irc.libera.chat:6697/squirreljme) -- Main Support
 137      * [#squirreljme-softwares](ircs://irc.libera.chat:6697/squirreljme-software) -- Software channel
 138      * [##squirreljme](ircs://irc.libera.chat:6697/#squirreljme) -- Off-Topic
 139    * [Reddit](https://reddit.com/r/SquirrelJME)
 140  * Front facing social media:
 141    * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA/)
 142    * [Twitter](https://twitter.com/SquirrelJME)
 143  * [Docker Hub](https://hub.docker.com/r/xerthesquirrel/squirreljme)
 144  * [SourceForge](https://sourceforge.net/p/squirreljme/)
 145  * Personal Accounts (If you wish to contact me this way)
 146    * [GitHub](https://github.com/XerTheSquirrel/)
 147    * [Keybase](https://keybase.io/xerthesquirrel)
 148    * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
 149    * [Mastodon (awoo.space)](https://awoo.space/@XerTheSquirrel)
 150    * [Twitter](https://twitter.com/XerShadowTail)
 151    * [YouTube (Personal)](
 152      https://www.youtube.com/channel/UCJ4QrvbDhjtd7u6EpfBQ__g)
 153    * E-Mail: <xer@multiphasicapps.net>
 154
 155 ## Goals
 156
 157  * _To be small_ - Smaller programs are easier to maintain and are usually
 158    simpler.
 159  * _To be fast_ - With the potential of AOT/JIT, systems that do not normally
 160    have a port of an existing virtual machine will usually only have an
 161    interpreter.
 162  * _To be compatible_ - So that existing Java ME 8 applications can run on this
 163    virtual machine, along with J2ME applications when required. This has the
 164    added bonus of allowing one to use older software to catalog for
 165    preservation.
 166  * _To compile once and run anywhere_ - Current and up to date Java
 167    implementations are limited only to a few select systems (_Solaris_,
 168    _Linux_, _BSD_, _Mac OS X_, and _Windows_). Java ME 8 as of this writing
 169    only supports the *FRDM-K64F* (dropped), *STM32429I-EVAL*, *Raspberry Pi*,
 170    *Intel Galileo Gen2* (preview), and *STM 32F746G DISCOVERY* (preview) all
 171    of which are either out of date or discontinued by their manufacturers.
 172    There are multitudes of devices that support **J2ME**, however that is
 173    horribly out of date when compared with the Java that is used today
 174    (**J2ME** is equal to Java 1.4 which was released in _2002_).
 175
 176 ## Donations
 177
 178 You may donate to SquirrelJME to which would be used by the author to keep the
 179 web server online, the purchasing of new hardware/software, and for the
 180 purchasing of food items for consumption.
 181
 182  * Traditional
 183    * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
 184    * [Patreon](https://www.patreon.com/SquirrelJME)
 185    * [Liberapay](https://liberapay.com/xershadowtail)
 186  * Cryptocurrency
 187    * _ALGO_: `TR5V27P33A2TH4CLHH2X3XQYV6WY4TYSDVUHUJDAINSMOJDNBB5BRTUKB4`
 188    * _ATOM_: `cosmos1xe5l7exx4sm0p7rr7sx3max5zxp0zx7mpx9vfj`
 189      * Always include this memo: `1523229`
 190    * _BTC_: `3AxDtLvmEk7h61BFy7J2v2t4s9m9uzWVvY`
 191    * _ETH_: `0x47B106506522f368c4c9110aF003a58dcD04beA1`
 192    * _LTC_: `M9GY2KbonbYKspqX5mrys6yNNvFab4RMQX`
 193    * _XLM_: `GDQP2KPQGKIHYJGXNUIYOMHARUARCA7DJT5FO2FFOOKY3B2WSQHG4W37`
 194      * Always include this memo: `2561990448`
 195    * _XTZ_: `tz1efFabxYdvPqNtdndC5y4usGSTvCH3RuhK`
 196    * _ZEC_: `t1cBD4dJYNWs5TQk1JKFNy1Qkg3TBx8noXQ`
 197
 198 ## Important Statements
 199
 200 ***JAVA AND ALL OTHER RELATED TRADEMARKS AND COPYRIGHTS ARE OWNED BY ORACLE
 201 CORPORATION <http://www.oracle.com/>.***
 202
 203 ***SQUIRRELJME IS NEITHER PRODUCED BY, ENDORSED BY, NOR SUPPORTED BY
 204 _ORACLE CORPORATION_.***
 205
 206 ***ALL SOURCE CODE IS WRITTEN BY MYSELF WITH FUNCTIONALITY DETERMINED BY THE
 207 DOCUMENTED APIS AND RUN-TIME BEHAVIOR. I HAVE NOT LOOKED AT THE SOURCE CODE FOR
 208 OTHER IMPLEMENTATIONS, NEITHER FREE SOFTWARE NOR PROPRIETARY IMPLEMENTATIONS.
 209 ESSENTIALLY SQUIRRELJME IS A CLEAN-ROOM IMPLEMENTATION OF THE DESIGN OF JAVA
 210 ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8 APIS AND ASSOCIATED JSRS/JEPS IS
 211 CONSIDERED BY MYSELF (STEPHANIE GAWRORISKI) TO BE IN THE FAIR USE.***
 212
 213 ***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
 214 100% COMPATIBLE WITH JAVA ME 8. THERE ARE CURRENTLY NO STABLE RELEASED VERSIONS
 215 OF THIS SOFTWARE. AS SUCH THE FIRST MAJOR VERSION RELEASE WILL BE WHEN IT IS
 216 COMPATIBLE SO AS TO NOT VIOLATE POTENTIAL LICENSES, AND IF POSSIBLE BE VERIFIED
 217 WITH ANY APPLICABLE TCKS (SO IT WOULD BE AN "OFFICIAL" IMPLEMENTATION).***
 218