readme.mkd 6.27 KB
Newer Older
1
# SquirrelJME
2

3
 * Copyright (C) 2013-2018 Stephanie Gawroriski
4
   <xer@multiphasicapps.net>
5
 * Copyright (C) 2013-2018 Multi-Phasic Applications
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
6
7
8
   <http://multiphasicapps.net/>
 * _Lex_ (The SquirrelJME Mascot) was drawn by...
   * "_Puppenstein_" <http://www.furaffinity.net/user/puppenstein/>
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
9
 * Support me on [Patreon](https://www.patreon.com/XerTheSquirrel)!
10

11
**SquirrelJME** is intended to be a Java ME 8 compatible environment for
12
13
14
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.
15
16
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
17
18
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.
19

20
21
22
23
24
25
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.

26
27
 * [Version 0.0.2 Release Progress](
   https://github.com/XerTheSquirrel/SquirrelJME/projects/2)
28
29
30
31
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
 * [Code of Conduct](code-of-conduct.mkd)
32
 * [Building](building.mkd)
33
 * [Changelog](changelog.mkd)
34
 * [Contributing](contributing.mkd)
35
 * [Design Document](design.mkd)
36
 * [Developer Notes](assets/developer-notes/index.mkd)
37
 * [History](history.mkd)
38
 * [Release Route](route.mkd)
39
 * [Project Scope](scope.mkd)
40
 * [Compatibility](compatibility.mkd)
41
 * [SquirrelJME As A Runtime](asruntime.mkd)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
42

43
44
## Repository

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

66
## Links
67

68
 * Locations where you can get support:
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
69
   * [Discord](https://discord.gg/9PkMMKt)
70
71
 * Front facing social media:
   * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA)
72
 * Personal Accounts (If you wish to contact me this way)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
73
   * [GitHub](https://github.com/XerTheSquirrel/)
74
   * [Keybase](https://keybase.io/xerthesquirrel)
75
   * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
76
   * [Mastodon (awoo.space)](https://awoo.space/@XerTheSquirrel)
77
   * [Twitter](https://twitter.com/MultiPhasicApps)
78

79
80
81
## Goals

 * _To be self-hosting_ - it can build itself while running on itself, provided
Stephanie Gawroriski's avatar
Fixups.    
Stephanie Gawroriski committed
82
   there is a filesystem and enough memory.
83
84
85
86
87
88
 * _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
89
90
91
   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
92
93
94
95
96
97
98
 * _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_).
99
100
101

## Donations

102
103
104
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.
105

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
106
 * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
107
 * [Patreon](https://www.patreon.com/XerTheSquirrel)
108
109
 * BitCoin (**BTC/XBT**): [`13UYwi2zuQd8NLhjyu1BA7a8NWktDotmq4`](
   bitcoin:13UYwi2zuQd8NLhjyu1BA7a8NWktDotmq4)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
110
111
 * Ethereum (**ETH**): [`0xf9C7d3a5496E66140de099EEFBa1eD8446b319d2`](
   ethereum:0xf9C7d3a5496E66140de099EEFBa1eD8446b319d2)
112
113
 * LiteCoin (**LTC**): [`Lf7d8X9LQ6GMTuwUMtnDqzqdsmQ4W5mN6i`](
   litecoin:Lf7d8X9LQ6GMTuwUMtnDqzqdsmQ4W5mN6i)
114

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
115
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
116

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

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

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
122
123
124
125
***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
126
ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
127
128
129
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
130

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
131
132
133
134
135
136
137
***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).***