readme.mkd 5.42 KB
Newer Older
1
# SquirrelJME
2

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
3
4
5
6
7
8
 * Copyright (C) 2013-2016 Steven Gawroriski
   <steven@multiphasicapps.net>
 * Copyright (C) 2013-2016 Multi-Phasic Applications
   <http://multiphasicapps.net/>
 * _Lex_ (The SquirrelJME Mascot) was drawn by...
   * "_Puppenstein_" <http://www.furaffinity.net/user/puppenstein/>
9

10
**SquirrelJME** is intended to be a Java ME 8 compatible environment for
11
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.

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
15
16
17
The source is written in pure Java and is designed to use small amounts of
memory, where simplicity increases operation speed without sacrificing
quality.
18

19
20
Note that Java ME 8 has a Java 7 virtual machine with specific limitations.

21
## Licenses
22

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
23
24
25
26
 * Source:
   [GNU General Public License, Version 3 or later](license.mkd)
 * Non-Source:
   [Creative Commons CC-BY-SA 4.0](license.mkd)
27

28
29
## Repository

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
30
31
32
 * [Online repository](http://multiphasicapps.net/)
   * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
   * The repository may be cloned with:
33
     * `fossil clone -u http://multiphasicapps.net/ squirreljme.fossil`
34
35
36
     * `mkdir squireljme`
     * `cd squirreljme`
     * `fossil open ../squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
37
   * Trunk Source Snapshot (`fossil serve` only):
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
38
39
     * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
     * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
40
41
42
   * Read-Only Mirrors:
     * Bitbucket: <https://bitbucket.org/mpasteven/squirreljme>
     * GitHub: <http://github.com/mpasteven/SquirrelJME/>
43
44
     * Tor: <http://squirrelzarhffxz.onion/>
       (`fossil clone -u http://squirrelzarhffxz.onion/ squirreljme.fossil`)
45

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
46
## Documents
47

48
 * [Code of Conduct](code-of-conduct.mkd)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
49
50
51
 * [Developer Notes](/uv/developer-notes/index.mkd)
   * [Alternative URL](http://multiphasicapps.net/uv/developer-notes/index.mkd)
     (Links to the main repository)
52
 * [Manual](src/assets/manual/index.mkd)
53
 * [Project Scope](scope.mkd)
54
 * [Why?](src/assets/manual/user/why.mkd)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
55

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
56
## Links
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
57

58
59
60
61
62
63
64
 * Locations where you can get support:
   * [Freenode #squirreljme](ircs://irc.freenode.net:6697/squirreljme)
   * [Mailing List](https://sourceforge.net/p/squirreljme/mailman/)
   * [SourceForge Project](http://www.sourceforge.net/projects/squirreljme)
 * Front facing social media:
   * [Twitter](https://twitter.com/MultiPhasicApps)
   * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA)
65

66
67
68
## Goals

 * _To be self-hosting_ - it can build itself while running on itself, provided
Stephanie Gawroriski's avatar
Fixups.    
Stephanie Gawroriski committed
69
   there is a filesystem and enough memory.
70
71
72
73
74
75
 * _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
76
   virtual machine, along with J2ME applications when required.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
77
78
79
80
81
82
83
 * _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_).
84
85
86

## Donations

87
88
89
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.
90

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
91
92
93
94
95
96
97
 * BitCoin (**BTC/XBT**): [`1HNRD44krsCFUzUvVWaXr5jqvuyZDZy71M`](
   bitcoin:1HNRD44krsCFUzUvVWaXr5jqvuyZDZy71M)
 * LiteCoin (**LTC**): [`LKytAQcbPyox75uYMKo1NH1w2k1SqBaELi`](
   litecoin:LKytAQcbPyox75uYMKo1NH1w2k1SqBaELi)
 * DogeCoin (**DOGE**): [`DPsW21MV8RMuXhA3GoN8VPjkmQEugrEn8h`](
   dogecoin:DPsW21MV8RMuXhA3GoN8VPjkmQEugrEn8h)
 * [FreedomSponsors](https://freedomsponsors.org/user/mpasteven/)
98

99
100
101
102
103
104
## Compatiblity

SquirrelJME intends to be 99.9% compatible with Java ME 8 and older J2ME
standards. In the case where compatibility is _purposefully_ broken, it will
be documented in the following document:

105
 * [Purposeful Compatiblity Breakages](/uv/javadoc/compatibility.mkd).
106

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
107
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
108

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

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

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
114
115
116
117
***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
118
ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
119
120
121
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
122

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
123
124
125
126
127
128
129
***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).***