Skip to content

Commit 64edbbb

Browse files
committed
[readme] add component table
1 parent 1b96e14 commit 64edbbb

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -25,28 +25,29 @@ Builds for older boards should work on newer boards, the performance might just
2525

2626

2727
## Components
28-
The output consists of these parts:
29-
* JRI for the brick - `jri-*.zip`
30-
* Stripped down version of Java -- a Java Runtime Image
31-
* Intended for normal users.
32-
* Full JDK running on the brick - `jdk-*.zip`
33-
* Intended for Linux power users.
34-
* Brick jmods - `jmods-*.zip`
35-
* They can be used for creating custom JRIs.
36-
* Intended for advanced users wanting to add additional OpenJDK modules.
28+
The build process produces these files:
29+
30+
| Name | File name | Summary | Where it runs | Who is it for | What is it useful for |
31+
|-------|-----------------|-------------------|---------------|-------------------|-------------------------------------------------|
32+
| JRI | `jri-ev3.zip` | Minimal runtime | Brick | Java developer | Running Java programs on ev3dev. |
33+
| JDK | `jdk-ev3.zip` | Full JDK | Brick | ev3dev power user | Compiling Java programs directly on the brick. |
34+
| JMODs | `jmods-ev3.zip` | Runtime precursor | Developer PC | both | Creating runtime images with more Java modules. |
35+
_JRI stands for "Java Runtime Image". The term itself is not specific to this project, it is equivalent to [Modular Run-Time Image](https://openjdk.java.net/jeps/220)._
3736

3837
## Building
3938

40-
0. Clone/download this repo to your computer.
39+
0. Clone this repository.
4140
1. Install [Docker](https://docs.docker.com/engine/installation/) for your operating system.
42-
2. Build the jdk cross-compilation OS:
41+
2. Build the base cross-compilation image:
4342
```sh
4443
sudo docker build -t ev3dev-lang-java:jdk-stretch -f system/Dockerfile.armel system
4544
```
46-
3. Build the jdk cross-compilation environment:
45+
3. Build the image with OpenJDK cross-compilation scripts:
4746
```sh
4847
sudo docker build -t ev3dev-lang-java:jdk-build -f scripts/Dockerfile scripts
4948
```
49+
Next steps depend on whether you want to navigate the build yourself, or if you want the build to run automatically.
50+
5051
### Semi-manual build
5152
4. Run the newly prepared container. You have to mount a host directory to the the `/build` directory in the container,
5253
otherwise the build would get discarded. The final build needs at least 6.5 GB of free space (in the build directory).

0 commit comments

Comments
 (0)