readme.mkd 6.16 KB
Newer Older
1
# SquirrelJME
2

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
3
 * Copyright (C) 2013-2017 Steven Gawroriski
4
   <xer@multiphasicapps.net>
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
5
 * Copyright (C) 2013-2017 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/>
9
 * Support me on [Patreon](https://www.patreon.com/mpasteven)!
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
17
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
this software to be used for archival purposes.
18

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
19
20
21
The source is written in pure Java and is designed to use small amounts of
memory, where simplicity increases operation speed without sacrificing
quality.
22

23
24
Note that Java ME 8 has a Java 7 virtual machine with specific limitations.

25
## Licenses
26

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

32
33
## Repository

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
34
 * [Online repository](http://multiphasicapps.net/)
35
36
37
38
   ([HTTPS](https://multiphasicapps.net/))
 * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
 * The repository may be cloned with:
   * One of these commands
39
     * `fossil clone -u http://multiphasicapps.net/ squirreljme.fossil`
40
41
42
43
44
45
46
47
48
     * `fossil clone -u https://multiphasicapps.net/ squirreljme.fossil`
   * `mkdir squireljme`
   * `cd squirreljme`
   * `fossil open ../squirreljme.fossil`
 * 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>
49
   * GitHub: <https://github.com/XerTheSquirrel/SquirrelJME>
50
51
52
   * GitLab: <https://gitlab.com/mpasteven/SquirrelJME>
   * Tor: <http://squirrelzarhffxz.onion/>
     (`fossil clone -u http://squirrelzarhffxz.onion/ squirreljme.fossil`)
53

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
54
## Documents
55

56
 * [Code of Conduct](code-of-conduct.mkd)
57
58
59
60
 * [Developer Notes](assets/developer-notes/index.mkd)
   (In repository)
   * [Unversioned Notes](/uv/developer-notes/index.mkd)
     (In unversioned space, will be up to date for the current day)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
61
   * [Alternative URL](http://multiphasicapps.net/uv/developer-notes/index.mkd)
62
63
     ([HTTPS](https://multiphasicapps.net/uv/developer-notes/index.mkd);
     Links to the main repository, do not follow via Tor use the direct link)
64
 * [Manual](assets/manual/index.mkd)
65
 * [Project Scope](scope.mkd)
66
 * [Why?](assets/manual/user/why.mkd)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
67

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
68
## Links
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
69

70
71
72
73
74
 * 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:
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
75
   * [Mastodon](https://mastodon.social/@XerTheSquirrel)
76
77
   * [Twitter](https://twitter.com/MultiPhasicApps)
   * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA)
78
79
80
81
 * Personal Accounts (If you wish to contact me this way)
   * [FurAffinity](https://www.furaffinity.net/user/mpasteven/)
   * [GitHub](https://github.com/mpasteven/)
   * [LinkedIn](https://www.linkedin.com/in/steven-gawroriski/)
82

83
84
85
## Goals

 * _To be self-hosting_ - it can build itself while running on itself, provided
Stephanie Gawroriski's avatar
Fixups.    
Stephanie Gawroriski committed
86
   there is a filesystem and enough memory.
87
88
89
90
91
92
 * _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
93
   virtual machine, along with J2ME applications when required.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
94
95
96
97
98
99
100
 * _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_).
101
102
103

## Donations

104
105
106
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.
107

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
108
 * [Patreon](https://www.patreon.com/mpasteven)
109
110
111
112
 * BitCoin (**BTC/XBT**): [`13UYwi2zuQd8NLhjyu1BA7a8NWktDotmq4`](
   bitcoin:13UYwi2zuQd8NLhjyu1BA7a8NWktDotmq4)
 * Ethereum (**ETH**): [`0x9738136f7EcB11d554Ef767704F62216a646e0AB`](
   ethereum:0x9738136f7EcB11d554Ef767704F62216a646e0AB)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
113
114
115
 * LiteCoin (**LTC**): [`LKytAQcbPyox75uYMKo1NH1w2k1SqBaELi`](
   litecoin:LKytAQcbPyox75uYMKo1NH1w2k1SqBaELi)
 * [FreedomSponsors](https://freedomsponsors.org/user/mpasteven/)
116

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
117
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
118

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
119
120
121
122
***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
123

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

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