Review Getting Started

ev3dev-lang-java · jabrena · Nov 13, 2018 · Jun 24, 2017 · Jun 24, 2017 · Jun 24, 2017
commit 924e8b92ed95c04a04a88b0f0f1993cbd8d175b4
diff --git a/src/main/asciidoc/getting_started/HelloWorld.java b/src/main/asciidoc/getting_started/HelloWorld.java
@@ -0,0 +1,8 @@
+public class HelloWorld {
+
+    public static void main(String[] args) {
+        // Prints "Hello, World" to the terminal window.
+        System.out.println("Hello, World");
+    }
+
+}
diff --git a/src/main/asciidoc/getting_started/brick.adoc b/src/main/asciidoc/getting_started/brick.adoc
@@ -19,11 +19,11 @@ sudo apt-get dist-upgrade
 sudo reboot
 ```
 
-### 2. Install Java on your brick
+## 2. Install Java on your brick
 
-For this step exist 2 paths. One path is for EV3 Brick and another path for BrickPi users and PiStorms users. 
+For this step exists 2 paths. One path is for EV3 Brick and another path for BrickPi/PiStorms users.
 
-**2.1 EV3 Brick:**
+### 2.1 EV3 Brick
 
 The EV3 Brick was designed with a SOC based on [ARM EABI](https://wiki.debian.org/ArmEabiPort) 
 and the best JVM option for that hardware architecture is the Oracle JRE 8 to install in the brick but, it is not possible to install directly in the brick
@@ -40,7 +40,7 @@ Once, you have the file on the brick, you can continue the Java installation wit
 
 https://github.com/ev3dev-lang-java/installer
 
-**Using the installer:**
+#### Using the installer
 
 ```
 cd /home/robot
@@ -52,7 +52,7 @@ sudo ./installer.sh help
 sudo ./installer.sh
 ```
 
-**Manual way:**
+#### Manual way
 
 ```
 tar -zxvf "/home/robot/ejdk-8-fcs-b132-linux-arm-sflt-03_mar_2014.tar.gz" -C /opt
@@ -62,7 +62,7 @@ java -version
 
 Now, you have Java on your EV3 Brick
 
-**2.2 BrickPi+ / PiStorms:**
+### 2.2 BrickPi 3 / BrickPi+ / PiStorms
 
 Using the installer, it is possible to automate everything:
 
@@ -78,11 +78,11 @@ sudo ./installer.sh help
 sudo ./installer.sh
 ```
 
-### 3. Create your first Project and deploy on your Brick
+## 3. Create your first Project and deploy on your Brick
 
 Once you have the required infrastructure on your Brick, it is possible to experiment with the libraries in some ways:
 
-**3.1 Using a Gradle template project**
+### 3.1 Using a Gradle template project
 
 If you like, you can experiment with the project, using the following project template:
 
@@ -112,7 +112,7 @@ Besides, exist a task to provide access to a Profiling tool if you execute:
 ./gradlew deployAndProfilingRun
 ```
 
-**3.2 Create a project from scratch:**
+### 3.2 Create a project from scratch
 
 Another alternative is the creation of a project from Scratch using Maven/Gradle.
 

diff --git a/src/main/asciidoc/getting_started/laptop.adoc b/src/main/asciidoc/getting_started/laptop.adoc
@@ -1,8 +1,8 @@
-= Getting Started on your computer
+# Getting Started on your computer
 
-== 1. Install/Update your development environment
+## 1. Install/Update your development environment
 
-=== 1.1 Install Java
+### 1.1 Install Java
 
 To begin any Java development, you need to be installed Java. 
 
@@ -17,7 +17,7 @@ brew install Caskroom/cask/java
 
 Further information about Java: https://www.java.com/es/about/whatis_java.jsp[https://www.java.com/es/about/whatis_java.jsp]
 
-=== 1.2 Install Maven/Gradle
+### 1.2 Install Maven/Gradle
 
 *OSX:*
 
@@ -31,18 +31,33 @@ Further information about Maven &amp; Gradle:
 https://maven.apache.org/[https://maven.apache.org/]
 https://gradle.org/[https://gradle.org/]
 
-=== 1.3 Install a Git Client
+### 1.3 Install a Git Client
 
 Install a visual Git Client to download this repository.
 https://www.sourcetreeapp.com/[https://www.sourcetreeapp.com/]
 
-=== 1.4 Install a Java IDE
+### 1.4 Install a Java IDE
 
-Install a Java IDE to use this repository with examples about
-ev3dev-lang-java.
+Install a Java IDE to develop Java Software
 https://www.jetbrains.com/idea/[https://www.jetbrains.com/idea/]
 
-=== 1.5 Download the repository on your computer
+## 2. Test your local environment
 
-Using SourceTree, try to donwload the repository on local. The address
-about the repository is: https://github.com/ev3dev-lang-java/ev3dev-lang-java.git[https://github.com/ev3dev-lang-java/ev3dev-lang-java.git]
+Once, you have installed everything, it is necessary to verify that everything goes well.
+
+Create a file with the name of HelloWorld.java and copy and paste on it the following content:
+
+[source,java]
+----
+    include::./HelloWorld.java[]
+----
+
+Later, open a terminal and type:
+
+``` java
+javac HelloWorld.java
+java HelloWorld
+```
+
+You should read: `HelloWorld` if the answer is **Yes**, your installation process on your
+personal computer has finished.
diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc
@@ -1,25 +1,18 @@
 # EV3Dev-Java / docs
 
-## About the project
-
-Learn details about the project itself.
-
-* link:./about/ev3dev-java.html[What is EV3Dev-java?]
-* link:./about/ev3dev-compatibility.html[Compatibility table]
-
 ## Getting Started
 
-Learn how to install the minimum Java infrastructure in your local computer
-and the required requisites on your brick to develop Software for robots.
-
-* link:./getting_started/laptop.html[Laptop]
-* link:./getting_started/brick.html[Brick]
+* link:./getting_started/laptop.html[Getting started with your Laptop]
+* link:./getting_started/brick.html[Getting started with your Brick]
 
 ## Fundamentals of Robotics
 
-Learn the basic concepts about Robotics.
-
 * link:./introduction/whatIsARobot.html[What is a robot?]
 * link:./architecture/index.html[The robot architecture]
 * link:./actuators/index.html[Actuators]
 * link:./sensors/index.html[Sensors]
+
+## About the project
+
+* link:./about/ev3dev-java.html[What is EV3Dev-java?]
+* link:./about/ev3dev-compatibility.html[Compatibility table]