readme.mkd 8.46 KB
Newer Older
1
# SquirrelJME
2

3
**SquirrelJME** is intended to be a Java ME 8 compatible environment for
4
5
6
strange and many other devices. That is, you would be able to have a Java
environment on a wide range of _Internet of Things_ devices, older computers
(such as the _Amiga_), embedded devices, and mobile devices from old to new.
7
8
It intends to be 99.9% compatible with Java ME 8 and older J2ME standards. It
should be able to run a wide range of older J2ME software which would enable
9
10
this software to be used for archival purposes. It is written purely in Java
and requires only a Java compiler and virtual machine for it to be built.
11

12
13
14
15
16
17
Note that **SquirrelJME** is not a Java SE virtual machine nor does it intend
to be one at all. As such, it will not be able to run desktop software unless
it is ported to Java ME. However some programs may run since Java ME is a
subset of Java SE, so provided the desktop software does not use what is
missing or not supported it will run.

18
 * Copyright (C) 2013-2019 Stephanie Gawroriski
19
   <xer@multiphasicapps.net>
20
 * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2019
21
 * _Lex_ and The _SquirrelJME_ Logo were illustrated by...
22
   * Kat Adam-MacEwen
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
23
   * Kat@CMYKat Designs & Illustrations <http://www.cmykat-designs.com/>
24

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
25
Please support me on [Patreon](https://www.patreon.com/SquirrelJME)!
26

27
28
Badges:

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
29
 * [![CircleCI](
30
   https://img.shields.io/circleci/build/github/XerTheSquirrel/SquirrelJME/trunk.svg)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
31
   https://circleci.com/gh/XerTheSquirrel/SquirrelJME/tree/trunk)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
32
33
34
 * [![Patreon](
   https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2FSquirrelJME%2Fpledges&style=flat)](
   https://www.patreon.com/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
35
 * [![Liberapay](
36
  https://img.shields.io/liberapay/receives/xershadowtail.svg?logo=liberapay)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
37
   https://liberapay.com/xershadowtail)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
38
39
 * [![Discord](https://img.shields.io/discord/278929900893634560.svg)](
   https://discord.gg/9PkMMKt)
40

41
42
Information:

43
 * [Code of Conduct](code-of-conduct.mkd)
44
45
46
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
47
   * _Fonts_ : SIL Open Font License Version 1.1
48
49
50
51
52
53
 * [Contributing to SquirrelJME](contributing.mkd)
 * _End-User Documents_
   * [Building](building.mkd)
   * [Changelog](changelog.mkd)
   * [Compatibility](compatibility.mkd)
   * [History](history.mkd)
54
   * [Release Roadmap](route.mkd)
55
   * [Usage](usage.mkd)
56
 * _Developer Resources_
57
58
   * [CircleCI Status](
     https://circleci.com/gh/XerTheSquirrel/SquirrelJME/tree/trunk)
59
   * [Developer Guide](developer-guide.mkd)
60
61
62
63
64
65
   * [Developer Notes](assets/developer-notes/index.mkd)
   * [Design Document](design.mkd)
   * [Project Scope](scope.mkd)
   * [SquirrelJME As A Runtime](asruntime.mkd)
   * [CLDC 1.8 API (docs.oracle.com)](
     https://docs.oracle.com/javame/8.0/api/cldc/api/overview-summary.html)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
66

67
68
69
70
Also check out SquirrelJME's sister project _Mu_ at:

 * <https://github.com/meepingsnesroms/Mu>

71
72
73
74
75
76
77
78
79
80
81
82
83
## I Am Open For Hiring

**SquirrelJME** is a hobby project (which means I work on it in my spare time)
and as such does not sustain me monetarily. If you do like my work please also
be advised that I am available for hire to work on a number of other projects
potentially. Most of my experience for languages is in _C_, _Java_, and
_POSIX Shell_. Although I do not mainly use other languages they can be learned
by adapting my current experience with those languages. **SquirrelJME** itself
mostly relates to embedded, compiler, and Java development. I prefer remote
development as it allows me to work from home rather than spending time
commuting every day (which wastes time). Interest can be e-mailed to me
(Stephanie Gawroriski) at <xerthesquirrel@gmail.com>.

84
85
## Repository

86
87
 * [Online repository](http://squirreljme.cc/)
   ([HTTPS](https://squirreljme.cc/),
88
89
   [Tor (A)](http://squirrelzarhffxz.onion/),
   [Tor (B)](http://squirrelmfbf2udn.onion/))
90
 * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
91
92
 * The repository may be cloned using Fossil:
   * One of these commands:
93
94
     * `fossil clone -u http://squirreljme.cc/ squirreljme.fossil`
     * `fossil clone -u https://squirreljme.cc/ squirreljme.fossil`
95
     * `fossil clone -u http://squirrelzarhffxz.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
96
     * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
97
   * `mkdir squirreljme`
98
99
   * `cd squirreljme`
   * `fossil open ../squirreljme.fossil`
100
101
102
 * Alternatively via [GitHub](https://github.com/XerTheSquirrel/SquirrelJME):
   * `git clone https://github.com/XerTheSquirrel/SquirrelJME`
   * `cd SquirrelJME`
103
 * Trunk Source Snapshot (Main website or `fossil serve` only):
104
105
   * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
   * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
106

107
## Links
108

109
 * [My Portfolio](https://shadowtail.dev/)
110
 * [My Public PGP Key](public-key.gpg.mkd)
111
 * [SquirrelJME Twitter](https://twitter.com/MultiPhasicApps)
112
 * Locations where you can get support:
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
113
   * [Discord](https://discord.gg/9PkMMKt)
114
 * Front facing social media:
115
116
   * [YouTube](
     https://www.youtube.com/playlist?list=PLpBpyrtWn1U3motx3AUOm70qG5zraCepD)
117
 * Personal Accounts (If you wish to contact me this way)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
118
   * [GitHub](https://github.com/XerTheSquirrel/)
119
   * [Keybase](https://keybase.io/xerthesquirrel)
120
   * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
121
   * [Mastodon (awoo.space)](https://awoo.space/@XerTheSquirrel)
122
   * [Twitter](https://twitter.com/XerShadowTail)
123
   * E-Mail: <xer@multiphasicapps.net>
124

125
126
127
## Goals

 * _To be self-hosting_ - it can build itself while running on itself, provided
Stephanie Gawroriski's avatar
Fixups.    
Stephanie Gawroriski committed
128
   there is a filesystem and enough memory.
129
130
131
132
133
134
 * _To be small_ - Smaller programs are easier to maintain and are usually
   simpler.
 * _To be fast_ - With the potential of AOT/JIT, systems that do not normally
   have a port of an existing virtual machine will usually only have an
   interpreter.
 * _To be compatible_ - So that existing Java ME 8 applications can run on this
135
136
137
   virtual machine, along with J2ME applications when required. This has the
   added bonus of allowing one to use older software to catalog for
   preservation.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
138
139
140
141
142
143
144
 * _To compile once and run anywhere_ - Current and up to date Java
   implementations are limited only to a few select systems (_Solaris_,
   _Linux_, _BSD_, _Mac OS X_, and _Windows_). Java ME 8 as of this writing
   only supports the *FRDM-K64F* and the *Raspberry Pi*. There are multitudes
   of devices that support **J2ME**, however that is horribly out of date when
   compared with the Java that is used today (**J2ME** is equal to Java 1.4
   which was released in _2002_).
145
146
147

## Donations

148
149
150
You may donate to SquirrelJME to which would be used by the author to keep the
web server online, the purchasing of new hardware/software, and for the
purchasing of food items for consumption.
151

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
152
 * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
153
 * [Patreon](https://www.patreon.com/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
154
 * [Liberapay](https://liberapay.com/xershadowtail)
155
156
157
158
159
160
161
162
163
164
 * BitCoin (**BTC/XBT**):
   `3NEF6Pyt2JfWnb6hn7WFcwH5jpkHYPkTNj`
 * BitCoin Cash (**BCH**):
   `qrgww4z9aalgxyyddh5ax8jyy34c89phxuklp3hcwd`
 * Ethereum (**ETH**):
   `0x7C2316f5336C63855C199784a6e145921145B74a`
 * Ethereum Classic (**ETC**):
   `0x1b30e6411bd7da6dd72cA35dabD5b98BA25A0Ae7`
 * LiteCoin (**LTC**):
   `MAogNXdjPQ7ZABtpeXztCHf4UXvfiwTuGX`
165
166
 * Stellar Lumens (**XLM**):
   `GB4O2MAMTINKS6GM6RH34KO32TJMF4QZKZTFJBE4HIPFMKRBXFQ7IAF6`.
167
168
 * ZCash (**ZEC**):
   `t1cBD4dJYNWs5TQk1JKFNy1Qkg3TBx8noXQ`
169

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
170
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
171

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
172
173
174
***JAVA AND ALL OTHER RELATED TRADEMARKS AND COPYRIGHTS ARE OWNED BY ORACLE
CORPORATION <http://www.oracle.com/>.***

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
175
***SQUIRRELJME IS NEITHER PRODUCED BY NOR ENDORSED BY ORACLE CORPORATION.***
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
176

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
177
178
179
180
***ALL SOURCE CODE IS WRITTEN BY MYSELF WITH FUNCTIONALITY DETERMINED BY THE
DOCUMENTED APIS AND RUN-TIME BEHAVIOR. I HAVE NOT LOOKED AT THE SOURCE CODE FOR
OTHER IMPLEMENTATIONS, NEITHER FREE SOFTWARE NOR PROPRIETARY IMPLEMENTATIONS.
ESSENTIALLY SQUIRRELJME IS A CLEAN-ROOM IMPLEMENTATION OF THE DESIGN OF JAVA
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
181
ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
182
183
184
APIS AND ASSOCIATED JSRS/JEPS IS CONSIDERED BY MYSELF TO BE IN THE FAIR USE
(AND IT ALSO HELPS THE JAVA ECOSYSTEM BY PERMITTING IT TO RUN IN MORE PLACES
WHERE IT IS NOT SUPPORTED BY ORACLE).***
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
185

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
186
***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
187
188
189
190
100% COMPATIBLE WITH JAVA ME 8. THERE ARE CURRENTLY NO STABLE RELEASED VERSIONS
OF THIS SOFTWARE. AS SUCH THE FIRST MAJOR VERSION RELEASE WILL BE WHEN IT IS
COMPATIBLE SO AS TO NOT VIOLATE POTENTIAL LICENSES, AND IF POSSIBLE BE VERIFIED
WITH ANY APPLICABLE TCKS (SO IT WOULD BE AN "OFFICIAL" IMPLEMENTATION).***
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
191
192