10000 Splitting section laptop by OS criteria. · ev3dev-lang-java/docs@05be296 · GitHub
[go: up one dir, main page]
Skip to content

Commit 05be296

Browse files
jabrenajabrena
committed
Splitting section laptop by OS criteria.
Adding initial support for Windows
1 parent 5411cb6 commit 05be296

File tree

5 files changed

+304
-188
lines changed

5 files changed

+304
-188
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ sudo ./installer.sh java
124124
#### Manual way
125125

126126
```
127-
tar -zxvf "/home/robot/ejdk-8-fcs-b132-linux-arm-sflt-03_mar_2014.tar.gz" -C /opt
127+
sudo tar -zxvf "/home/robot/ejdk-8-fcs-b132-linux-arm-sflt-03_mar_2014.tar.gz" -C /opt
128128
sudo update-alternatives --install /usr/bin/java java /opt/ejdk1.8.0/linux_arm_sflt/jre/bin/java 1
129129
```
130130

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

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,52 @@
55
Learn or test a new Technology is always a new challenge.
66
This section tries to reduce the time invested to install
77
the componentes required on your Personal
8-
computer and the Brick to enjoy with the robots that you will be create with `Java`.
8+
computer and the `Mindstorms Brick` to enjoy with the `Robots` that you will be create with `Java`.
99

1010
The project has been designed with the idea that the user creates Java programs in a Personal computer
11-
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
12-
but in this case with Robotics programs with Java.
11+
and later send the programs to any Mindstorms Brick with the help of remote connections.
12+
Following this approach, the user will learn the same techniques applied in the industry with Enterprise applications
13+
but in this case, applying the same techniques in a educational Robotics context with Java.
1314

14-
## The Steps
15+
## Software & Hardware requirements
1516

1617
### Personal computer
1718

1819
Modern development environments always require the same stuff:
19-
a package manager to install software easily, a runtine about the technology,
20-
a build system to manage the dependencies and the whole life cycle,
21-
integrated development environments and tools to store code in source code repositories.
22-
In this project, the components to install are:
2320

2421
- A package manager
2522
- Java JDK
2623
- Build Systems (Maven & Gradle)
2724
- Java IDE (IntelliJ or Eclipse)
2825
- Git & SourceTree
2926
27+
A package manager to install software easily, a runtime about the technology,
28+
a build system to manage the dependencies and the whole software life cycle,
29+
integrated development environments and tools to store code in source code repositories.
30+
3031
In the section about link:laptop.html[Getting started with your personal computer],
31-
you will learn how to install all components.
32+
you will learn how to install all components for the most popular Operating systems in the market:
33+
34+
- Windows
35+
- OSX
36+
- Linux
37+
38+
In order to develop software for Robots with Java.
39+
40+
### Mindstorms Brick
41+
42+
The Mindstorms Brick is the heart of this project. In the third generation of the product series LEGO Mindstorms,
43+
exist in the 3 market 3 possible Bricks compatible with this project:
44+
45+
- LEGO Mindstorms EV3
46+
- BrickPi
47+
- PiStorms
48+
49+
The requirements to execute Java programs in any Brick are the same that in any Personal computer:
3250

33-
### The brick
51+
- Operating System
52+
- Java Virtual Machine
3453
35-
The requirements of the Brick are simple:
36-
An Linux Operating System and a Java Virtual Machine, JVM.
37-
If your Brick is a Lego Mindstorms EV3, BrickPi or PiStorms then you could use this project.
3854
In the section about link:brick.html[Getting started with your Brick],
3955
you will learn how to install the components.
4056

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

Lines changed: 6 additions & 174 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ then continue reading this document.
1313

1414
## The modern Java development environment
1515

16-
`Java` is possible to run in the most popular desktop Operating Systems like: `OSX`, `Windows` & `Ubuntu`.
16+
`Java` is possible to run in the most popular desktop Operating Systems like: `Windows`, `OSX` & `Ubuntu`.
1717

1818
The components that you will have to install are:
1919

@@ -25,181 +25,13 @@ The components that you will have to install are:
2525
2626
The software listed previously is possible to install manually but
2727
it is better the usage of a `package installer`
28-
like `HomeBrew` for OSX or `apt` for Ubuntu.
28+
like `HomeBrew` for OSX or `apt` for Linux.
2929

30-
### OSX
30+
Click in the Operating System installed in your personal computer to check the requirements.
3131

32-
If your personal computer is manufactured from Apple, the following instructions will help you.
33-
34-
#### Homebrew, the package manager for OSX
35-
36-
Homebrew is a free and open-source software package management system that simplifies the installation of software on Apple's macOS operating system.
37-
38-
[source]
39-
----
40-
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
41-
----
42-
43-
To check if you installed Homebrew:
44-
45-
[source]
46-
----
47-
brew config
48-
----
49-
50-
You should view the following output:
51-
52-
[source]
53-
----
54-
HOMEBREW_VERSION: 1.2.2
55-
ORIGIN: https://github.com/Homebrew/brew.git
56-
HEAD: 54e01d76db34a3a649c79b189873bfd0a52dbc9f
57-
Last commit: 4 weeks ago
58-
Core tap ORIGIN: https://github.com/Homebrew/homebrew-core
59-
Core tap HEAD: 530b7f9b6884bec2a8ea618d0a52c9691cef76bb
60-
Core tap last commit: 3 weeks ago
61-
HOMEBREW_PREFIX: /usr/local
62-
HOMEBREW_REPOSITORY: /usr/local/Homebrew
63-
HOMEBREW_CELLAR: /usr/local/Cellar
64-
HOMEBREW_BOTTLE_DOMAIN: https://homebrew.bintray.com
65-
CPU: quad-core 64-bit ivybridge
66-
Homebrew Ruby: 2.0.0-p648
67-
Clang: 8.1 build 802
68-
Git: 2.11.0 => /Library/Developer/CommandLineTools/usr/bin/git
69-
Perl: /usr/bin/perl
70-
Python: /usr/bin/python
71-
Ruby: /usr/bin/ruby => /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/bin/ruby
72-
Java: 9, 1.8.0_121, 1.8.0_05, 1.7.0_51
73-
macOS: 10.12.5-x86_64
74-
Xcode: N/A
75-
CLT: 8.3.2.0.1.1492020469
76-
X11: N/A
77-
----
78-
79-
In the next sections, we will continue using HomeBrew for the rest of installation steps.
80-
81-
TIP: If you have some problem with some concrete installation, you could install manually but it is bettert to unify
82-
the way to install everything.
83-
84-
Further information about link:https://brew.sh/[Homebrew]
85-
86-
#### Java
87-
88-
To program with Java is necessary to install in your laptop a Java Development Kit (JDK).
89-
90-
A Java Development Kit (JDK) is a program development environment
91-
for writing Java applications. It consists of a runtime environment that "sits on top" of the operating system layer
92-
as well as the tools and programming that developers need to compile, debug, and run applications
93-
written in the Java language.
94-
95-
To begin using Java, it is necessary to install the JDK:
96-
97-
[source]
98-
----
99-
brew update
100-
brew tap caskroom/cask
101-
brew install Caskroom/cask/java
102-
----
103-
104-
Once you have installed Java JDK, check the installation:
105-
106-
[source]
107-
----
108-
java -version
109-
----
110-
111-
You should view the following output:
112-
113-
[source]
114-
----
115-
java version "1.8.0_121"
116-
Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
117-
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)
118-
----
119-
120-
To check if you are able to compile Java files,
121-
create a new file with the name of `HelloWorld.java` and copy and paste on it the following content:
122-
123-
[source,java]
124-
----
125-
include::./HelloWorld.java[]
126-
----
127-
128-
Save the file and open in a terminal to type the following commands:
129-
130-
``` java
131-
javac HelloWorld.java
132-
java HelloWorld
133-
```
134-
135-
You should read: `HelloWorld` in the terminal.
136-
137-
Further information about link:https://www.java.com/es/about/whatis_java.jsp[Java]
138-
139-
#### Build Systems (Maven/Gradle)
140-
141-
Modern Java development use dependencies stored on Software Repositories.
142-
It is a good idea if you install the popular build Systems as `Maven` & `Gradle` for Java.
143-
This project is modular and it deliver multiple dependencies.
144-
145-
The way to install Maven & Gradle is:
146-
147-
148-
[source]
149-
----
150-
brew install maven
151-
brew install gradle
152-
----
153-
154-
Further information about link:https://maven.apache.org/[Maven] & https://gradle.org/[Gradle].
155-
156-
#### Java IDE
157-
158-
To develop a single Java file, maybe you could use a simple Text Editor
159-
but current Java IDE offers several funcionalities to
160-
help you in the process to develop software with Java. In the market, the most popular Java IDE are `IntelliJ` & `Eclipse`.
161-
162-
To install `IntelliJ`:
163-
164-
[source]
165-
----
166-
brew cask install intellij-idea
167-
----
168-
169-
To install `Eclipse`:
170-
171-
[source]
172-
----
173-
brew cask install eclipse-java
174-
----
175-
176-
Further information about link:https://www.jetbrains.com/idea/[IntelliJ] & Eclipse
177-
178-
#### Sources & Repositories (Git & SourceTree)
179-
180-
Git is a popular technology to manage code. Many ideas that you see on Internet are stored on
181-
Git repositories so manage this technology is necessary.
182-
183-
[source]
184-
----
185-
brew cask install sourcetree
186-
----
187-
188-
Further information about link:https://www.sourcetreeapp.com/[SourceTree]
189-
190-
### Windows
191-
192-
[source]
193-
----
194-
PENDING
195-
----
196-
197-
### Ubuntu
198-
199-
[source]
200-
----
201-
PENDING
202-
----
32+
- link:laptop_windows.html[Windows]
33+
- link:laptop_osx.html[OSX]
34+
- Linux
20335
20436
++++
20537

0 commit comments

Comments
 (0)
0