8000 Improving documentation about Getting Started. · ev3dev-lang-java/docs@19e7dbe · GitHub
[go: up one dir, main page]
Skip to content

Commit 19e7dbe

Browse files
jabrenajabrena
committed
Improving documentation about Getting Started.
1 parent aedd1b8 commit 19e7dbe

File tree

3 files changed

+185
-47
lines changed

3 files changed

+185
-47
lines changed

‎src/main/asciidoc/getting_started/index.adoc

Lines changed: 34 additions & 14 deletions
  • < 8000 button aria-label="Display the source diff" aria-current="true" class="prc-SegmentedControl-Button-ojWXD prc-SegmentedControl-IconButton-O80Eh" style="--separator-color:transparent">
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,51 @@
22

33
## Introduction
44

5-
This section will guide you in your first steps with the project.
6-
To execute in your Brick your first robotics program with Java,
7-
it is necessary to install some components in your personal computer and your Brick.
5+
Learn or test a new Technology is always a new challenge. This section tries to
6+
reduce the time invested to install the required software to enjoy with
7+
`Java` and `Robotics` with the help of the products from Lego Mindstorms ecosystem.
8+
To start programming Robotics with Java, it is necessary to install some components in your personal computer and your Brick.
89

910
The project has been designed with the idea that the user creates Java programs in a Personal computer
1011
and later send the programs to Brick using a remote connections. With this approach, the user will learn the same techniques applied in the industry with Enterprise applications
1112
but in this case with Robotics programs with Java.
1213

13-
## Personal computer
14+
## The Steps
1415

15-
To use the libraries developed in this project, it is necessary to have installed
16-
in the personal computer a modern Java development environment composed by the following elements:
16+
### Personal computer
1717

18+
Modern environment to development requires always the same stuff:
19+
a package managers to install software easily, Runtine oriented to the technology, Build system to manage the dependencies and the whole life cycle,
20+
Integrated development environments IDE & Tools to store code in source code repositories.
21+
In this project, the components to install are:
22+
23+
- A package manager
1824
- Java JDK
1925
- Build Systems (Maven & Gradle)
26+
- Java IDE (IntelliJ or Eclipse)
2027
- Git & SourceTree
21-
- Java IDE like IntelliJ or Eclipse
22-
2328
2429
In the section about link:laptop.html[Getting started with your personal computer],
25-
you will learn how to install that elements.
30+
you will learn how to install all components.
31+
32+
### Brick
33+
34+
In the Brick side, the process to install sofware is easier because we only have 2 steps:
35+
36+
- Install a Operating System
37+
- Install a Java Virtual Machine, JVM
38+
39+
If your Brick is a Lego Mindstorms EV3, BrickPi or PiStorms then you could use this project.
40+
In the section about link:brick.html[Getting started with your Brick],
41+
you will learn how to install the components.
42+
43+
## The Next Step
44+
45+
If you are reading this section, you reach 2 goals:
2646

27-
## Brick
47+
- You executed the classic Java program `Hello World` in your personal computer
48+
- You executed some classic Java programs in your Brick.
2849
29-
This project supports multiple platforms like Lego Mindstorms EV3, BrickPi & PiStorms.
30-
If you have one of them, it is possible to use this project. In the section about link:./getting_started/brick.html[Getting started with your Brick],
31-
you will learn how to install a Linux Operating System and Java JRE to run later your own
32-
robotics programs with Java.
50+
In that case, continue with the next section about: `Fundamentals of Robotics`
51+
but if you stopped in some point, read previous documents again and if the problem
52+
continues, create a link:https://github.com/ev3dev-lang-java/ev3dev-lang-java/issues/[Support issue on the project].

‎src/main/asciidoc/getting_started/laptop.adoc

Lines changed: 150 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,96 @@
11
# Getting Started with your personal computer
22

3-
## Requirements
3+
## Introduction
44

5-
### Java
5+
This project is about `Java` to create Software for `Robots`, so the first question that you need to answer is:
66

7-
To program, with Java, it is necessary to install in your laptop Java JDK.
8-
To begin any Java development, you need to be installed Java.
7+
TIP: Is my personal computer ready to write Java programs in general?
98

10-
*OSX:*
9+
If the answer is **Yes**, you could Skip this document and jump directly to the section
10+
link:brick.html[Getting started with your Brick] but if you didn´ install Java and other Java components related
11+
in the computer that you are going to use with this project then it is pretty useful that continue reading this document.
12+
13+
## The modern Java development environment
14+
15+
`Java` is possible to run in the most popular desktop Operating Systems like: `OSX`, `Windows` & `Ubuntu`
16+
and Robotics platforms like `Lego Mindstorms`. The components that you will have to install are:
17+
18+
- A package manager
19+
- Java JDK
20+
- Build Systems (Maven & Gradle)
21+
- Java IDE (IntelliJ or Eclipse)
22+
- Sources & Repositories (Git & SourceTree)
23+
24+
The software listed previously is possible to install manually but it is better the usage of Package installer tools
25+
like `Brew` for OSX or `apt` for Ubuntu.
26+
27+
### OSX
28+
29+
If your personal computer is manufactured from Apple, the following instructions will help you.
30+
31+
#### Homebrew, the package manager for OSX
32+
33+
Homebrew is a free and open-source software package management system that simplifies the installation of software on Apple's macOS operating system.
34+
35+
[source]
36+
----
37+
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
38+
----
39+
40+
To check if you installed Homebrew:
41+
42+
[source]
43+
----
44+
brew config
45+
----
46+
47+
You should view the following output:
48+
49+
[source]
50+
----
51+
HOMEBREW_VERSION: 1.2.2
52+
ORIGIN: https://github.com/Homebrew/brew.git
53+
HEAD: 54e01d76db34a3a649c79b189873bfd0a52dbc9f
54+
Last commit: 4 weeks ago
55+
Core tap ORIGIN: https://github.com/Homebrew/homebrew-core
56+
Core tap HEAD: 530b7f9b6884bec2a8ea618d0a52c9691cef76bb
57+
Core tap last commit: 3 weeks ago
58+
HOMEBREW_PREFIX: /usr/local
59+
HOMEBREW_REPOSITORY: /usr/local/Homebrew
60+
HOMEBREW_CELLAR: /usr/local/Cellar
61+
HOMEBREW_BOTTLE_DOMAIN: https://homebrew.bintray.com
62+
CPU: quad-core 64-bit ivybridge
63+
Homebrew Ruby: 2.0.0-p648
64+
Clang: 8.1 build 802
65+
Git: 2.11.0 => /Library/Developer/CommandLineTools/usr/bin/git
66+
Perl: /usr/bin/perl
67+
Python: /usr/bin/python
68+
Ruby: /usr/bin/ruby => /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/bin/ruby
69+
Java: 9, 1.8.0_121, 1.8.0_05, 1.7.0_51
70+
macOS: 10.12.5-x86_64
71+
Xcode: N/A
72+
CLT: 8.3.2.0.1.1492020469
73+
X11: N/A
74+
----
75+
76+
In the next sections we will continue using HomeBrew for the rest of installation.
77+
78+
TIP: If you have some problem with some concrete installation, you could install manually but it is bettert to unify
79+
the way to install everything.
80+
81+
Further information about link:https://brew.sh/[Homebrew]
82+
83+
#### Java
84+
85+
To program, with Java, it is necessary to install in your laptop a
86+
A Java Development Kit (JDK).
87+
88+
A Java Development Kit (JDK) is a program development environment
89+
for writing Java applications. It consists of a runtime environment that "sits on top" of the operating system layer
90+
as well as the tools and programming that developers need to compile, debug, and run applications
91+
written in the Java language.
92+
93+
To begin using Java:
1194

1295
[source]
1396
----
@@ -16,14 +99,45 @@ brew tap caskroom/cask
1699
brew install Caskroom/cask/java
17100
----
18101

19-
Further information about Java: https://www.java.com/es/about/whatis_java.jsp[https://www.java.com/es/about/whatis_java.jsp]
102+
Test your java installation is easy:
103+
104+
[source]
105+
----
106+
java -version
107+
----
108+
109+
You should view the following output:
20110

21-
### Maven/Gradle
111+
[source]
112+
----
113+
java version "1.8.0_121"
114+
Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
115+
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)
116+
----
117+
118+
To check if you can compile java files, create a file with the name of HelloWorld.java and copy and paste on it the following content:
119+
120+
[source,java]
121+
----
122+
include::./HelloWorld.java[]
123+
----
124+
125+
Later, open a terminal and type:
126+
127+
``` java
128+
javac HelloWorld.java
129+
java HelloWorld
130+
```
131+
132+
You should read: `HelloWorld` in the terminal.
133+
134+
Further information about link:https://www.java.com/es/about/whatis_java.jsp[Java]
135+
136+
#### Build Systems (Maven/Gradle)
22137

23138
Modern Java development use dependencies stored on Software Repositories.
24139
It is a good idea if you install the popular Build Systems as `Maven` & `Gradle`
25140

26-
*OSX:*
27141

28142
[source]
29143
----
@@ -35,46 +149,50 @@ Further information about Maven &amp; Gradle:
35149
https://maven.apache.org/[https://maven.apache.org/]
36150
https://gradle.org/[https://gradle.org/]
37151

38-
### Git
152+
#### Java IDE
153+
154+
155+
To develop any Java file, with a text editor is enough but the right way to develop Java programs is using a Modern IDE
156+
like `IntelliJ` or `Eclipse`
157+
158+
[source]
159+
----
160+
brew cask install intellij-idea
161+
brew cask install eclipse-java
162+
----
163+
164+
Install a Java IDE to develop Java Software
165+
https://www.jetbrains.com/idea/[https://www.jetbrains.com/idea/]
166+
167+
#### Sources & Repositories (Git & SourceTree)
39168

40169
Git is a popular technology to manage code. Many ideas that you see on Internet are stored on
41170
Git repositories so manage this technology is necessary.
42171
Besides, the project includes some project templates to help you in the process to have your first project
43172
ready to use with your brick.
44173

174+
[source]
175+
----
176+
brew cask install sourcetree
177+
----
45178

46179
Install a visual Git Client to download this repository.
47180
https://www.sourcetreeapp.com/[https://www.sourcetreeapp.com/]
48181

49-
### Java IDE
50-
51182

52-
To develop any Java file, with a text editor is enough but the right way to develop Java programs is using a Modern IDE
53-
like `IntelliJ` or `Eclipse`
183+
### Windows
54184

55-
Install a Java IDE to develop Java Software
56-
https://www.jetbrains.com/idea/[https://www.jetbrains.com/idea/]
57-
58-
## Test your local environment
59-
60-
Once, you have installed everything, it is necessary to verify that everything goes well.
61-
62-
Create a file with the name of HelloWorld.java and copy and paste on it the following content:
63-
64-
[source,java]
185+
[source]
65186
----
66-
include::./HelloWorld.java[]
187+
PENDING
67188
----
68189

69-
Later, open a terminal and type:
190+
### Ubuntu
70191

71-
``` java
72-
javac HelloWorld.java
73-
java HelloWorld
74-
```
75-
76-
You should read: `HelloWorld` if the answer is **Yes**, your installation process on your
77-
personal computer has finished.
192+
[source]
193+
----
194+
PENDING
195+
----
78196

79197
++++
80198

‎src/main/asciidoc/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# EV3Dev-Java / docs
22

3-
This documentation will be useful in the way to learn `Robotics` with this `Java` project.
3+
This documentation will guide in the way to learn `Robotics` with this `Java` project.
44

55
## Getting Started
66

0 commit comments

Comments
 (0)
0