readme.mkd 6.65 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
19
20
21
22
23
24
25
26
27
28
 * Copyright (C) 2013-2018 Stephanie Gawroriski
   <xer@multiphasicapps.net>
 * Copyright (C) 2013-2018 Multi-Phasic Applications
   <http://multiphasicapps.net/>
 * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2018
 * _Lex_ (The SquirrelJME Mascot) was drawn by...
   * "_Puppenstein_" <http://www.furaffinity.net/user/puppenstein/>
 * The SquirrelJME Logo was illustrated by...
   * Kat Adam-MacEwen
   * Kat@CMYKat Designs & Illustrations <www.cmykat-designs.com>

29
30
You may support me on [Patreon](https://www.patreon.com/SquirrelJME)!

31
32
33
Information:

 * [Version 0.0.2 Release Progress (GitHub)](
34
   https://github.com/XerTheSquirrel/SquirrelJME/projects/2)
35
36
37
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
38
   * _Fonts_ : SIL Open Font License Version 1.1
39
 * [Code of Conduct](code-of-conduct.mkd)
40
 * [Building](building.mkd)
41
 * [Changelog](changelog.mkd)
42
 * [Contributing](contributing.mkd)
43
 * [Design Document](design.mkd)
44
 * [Developer Notes](assets/developer-notes/index.mkd)
45
 * [History](history.mkd)
46
 * [Release Route](route.mkd)
47
 * [Project Scope](scope.mkd)
48
 * [Compatibility](compatibility.mkd)
49
 * [SquirrelJME As A Runtime](asruntime.mkd)
50
51
 * [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
52

53
54
## Repository

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
55
 * [Online repository](http://multiphasicapps.net/)
56
   ([HTTPS](https://multiphasicapps.net/),
57
58
   [Tor (A)](http://squirrelzarhffxz.onion/),
   [Tor (B)](http://squirrelmfbf2udn.onion/))
59
 * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
60
61
 * The repository may be cloned using Fossil:
   * One of these commands:
62
     * `fossil clone -u http://multiphasicapps.net/ squirreljme.fossil`
63
     * `fossil clone -u https://multiphasicapps.net/ squirreljme.fossil`
64
     * `fossil clone -u http://squirrelzarhffxz.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
65
     * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
66
   * `mkdir squirreljme`
67
68
   * `cd squirreljme`
   * `fossil open ../squirreljme.fossil`
69
70
71
 * Alternatively via [GitHub](https://github.com/XerTheSquirrel/SquirrelJME):
   * `git clone https://github.com/XerTheSquirrel/SquirrelJME`
   * `cd SquirrelJME`
72
73
74
 * Trunk Source Snapshot (`fossil serve` only):
   * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
   * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
75

76
## Links
77

78
 * Locations where you can get support:
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
79
   * [Discord](https://discord.gg/9PkMMKt)
80
81
 * Front facing social media:
   * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA)
82
 * Personal Accounts (If you wish to contact me this way)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
83
   * [GitHub](https://github.com/XerTheSquirrel/)
84
   * [Keybase](https://keybase.io/xerthesquirrel)
85
   * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
86
   * [Mastodon (awoo.space)](https://awoo.space/@XerTheSquirrel)
87
   * [Twitter](https://twitter.com/MultiPhasicApps)
88

89
90
91
## Goals

 * _To be self-hosting_ - it can build itself while running on itself, provided
Stephanie Gawroriski's avatar
Fixups.    
Stephanie Gawroriski committed
92
   there is a filesystem and enough memory.
93
94
95
96
97
98
 * _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
99
100
101
   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
102
103
104
105
106
107
108
 * _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_).
109
110
111

## Donations

112
113
114
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.
115

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
116
 * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
117
 * [Patreon](https://www.patreon.com/SquirrelJME)
118
119
 * BitCoin (**BTC/XBT**): [`13UYwi2zuQd8NLhjyu1BA7a8NWktDotmq4`](
   bitcoin:13UYwi2zuQd8NLhjyu1BA7a8NWktDotmq4)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
120
121
 * Ethereum (**ETH**): [`0xf9C7d3a5496E66140de099EEFBa1eD8446b319d2`](
   ethereum:0xf9C7d3a5496E66140de099EEFBa1eD8446b319d2)
122
123
 * LiteCoin (**LTC**): [`Lf7d8X9LQ6GMTuwUMtnDqzqdsmQ4W5mN6i`](
   litecoin:Lf7d8X9LQ6GMTuwUMtnDqzqdsmQ4W5mN6i)
124

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
125
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
126

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

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

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
132
133
134
135
***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
136
ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
137
138
139
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
140

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
141
142
143
144
145
146
147
***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
100% COMPATIBLE WITH JAVA ME 8. THERE ARE CURRENTLY NO RELEASED VERSIONS OF
THIS SOFTWARE. AS SUCH THE FIRST 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).***