readme.mkd 4.86 KB
Newer Older
1
2
# Multi-Phasic Applications: SquirrelJME

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
34
35
36
     * `fossil clone http://multiphasicapps.net/ squirreljme.fossil`
     * `mkdir squireljme`
     * `cd squirreljme`
     * `fossil open ../squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
37
38
39
40
41
42
43
44
   * Trunk Source Snapshot (`fossil serve` only):
     * [TAR.GZ](../../tarball/squirreljme-trunk.tar.gz?uuid=trunk)
     * [ZIP](../../zip/squirreljme-trunk.zip?uuid=trunk)
   * Read-Only Mirrors:
     * Bitbucket: <https://bitbucket.org/mpasteven/squirreljme>
     * GitHub: <http://github.com/mpasteven/SquirrelJME/>
     * Tor: <http://x3v3lxoxpxu3hitk.onion/>
       (`fossil clone http://x3v3lxoxpxu3hitk.onion/ squirreljme.fossil`)
45

46
## Links
47

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
48
49
50
51
52
53
54
55
56
57
58
 * [Why?](src/manual/user/why.mkd)
 * [Sub-Reddit](https://www.reddit.com/r/SquirrelJME/)
 * [Mailing List](https://sourceforge.net/p/squirreljme/mailman/)
 * [SourceForge Project](http://www.sourceforge.net/projects/squirreljme)
 * [Manual](src/manual/index.mkd)
 * [Developer Notes](src/developer-notes/index.mkd)

## Social

 * [Twitter](https://twitter.com/MultiPhasicApps)
 * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA)
59

60
61
62
## Goals

 * _To be self-hosting_ - it can build itself while running on itself, provided
Stephanie Gawroriski's avatar
Fixups.    
Stephanie Gawroriski committed
63
   there is a filesystem and enough memory.
64
65
66
67
68
69
70
 * _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
   virtual machine.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
71
72
73
74
75
76
77
 * _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_).
78
79
80

## Donations

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
81
82
You may donate to SquirrelJME to help keep the author alive and to possibly
help the purchase of various hardware:
83

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
84
85
86
87
88
89
90
 * BitCoin (**BTC/XBT**): [`1HNRD44krsCFUzUvVWaXr5jqvuyZDZy71M`](
   bitcoin:1HNRD44krsCFUzUvVWaXr5jqvuyZDZy71M)
 * LiteCoin (**LTC**): [`LKytAQcbPyox75uYMKo1NH1w2k1SqBaELi`](
   litecoin:LKytAQcbPyox75uYMKo1NH1w2k1SqBaELi)
 * DogeCoin (**DOGE**): [`DPsW21MV8RMuXhA3GoN8VPjkmQEugrEn8h`](
   dogecoin:DPsW21MV8RMuXhA3GoN8VPjkmQEugrEn8h)
 * [FreedomSponsors](https://freedomsponsors.org/user/mpasteven/)
91

92
## Reporting Bugs/Features/Issues
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
93

94
95
96
97
98
You may report bugs, suggest features, and reveal issues on the following:

 * My E-mail Address.
 * The mailing list.
 * The sub-Reddit.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
99
100

## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
101

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
102
103
104
105
106
107
***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).***

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
108
109
110
111
112
113
***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
ME 8.***

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
114
115
116
117
118
***JAVA AND ALL OTHER RELATED TRADEMARKS AND COPYRIGHTS ARE OWNED BY ORACLE
CORPORATION <http://www.oracle.com/>. THE IMPLEMENTATIONS OF THE JAVA ME 8
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
119