Skip to content

Commit 78d32c1

Browse files
committed
Merge branch 'dev' of https://github.com/FHNW-IP5-IP6/GPIOSimulator into dev
2 parents 1915aad + 59ce89a commit 78d32c1

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

README.adoc

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,26 @@
33
*Creating GPIO projects in Java on the Raspberry Pi has never been this easy!*
44

55
== What is the GPIOSimulator
6-
7-
This project contains component classes for using sensors and actuators in java with the Rapsberry Pi. Additionally it has a rich tutorial to support new developers to try java for their GPIO projects raspberry pi project.
6+
This project contains component classes for using sensors and actuators in Java with the Raspberry Pi. Additionally, it has a rich tutorial to support new developers to try Java for their GPIO Raspberry Pi projects.
87

98
== Main Features
10-
11-
* Beginner friendly Component classes for easier usage of common sensors and actuators in Java
9+
* Beginner friendly component classes for easy usage of common sensors and actuators in Java
1210

1311
* Compatibility with the Grove Base Hat
1412

15-
* Compatiblity with Grove Sensors and Actuators
13+
* Compatibility with Grove Sensors and Actuators
1614

17-
* A rich tutorial for explaining all components
15+
* A rich tutorial which explains all components
1816

1917
* A sample project that shows how the components can work together
2018

21-
2219
== Installation
23-
24-
Download the Jar from the releases: +
20+
Download the `jar` file from the releases: +
2521
https://github.com/FHNW-IP5-IP6/GPIOSimulator/releases/
2622

27-
Add the file to the ressources of your project and add a new gradle dependency.:
23+
Add the file to the resources of your project and add a new gradle dependency:
2824

25+
[source]
2926
----
3027
repositories {
3128
mavenCentral()
@@ -40,11 +37,8 @@ dependencies {
4037
----
4138

4239
== Complete Tutorial
43-
4440
Visit the following page for a complete tutorial:
4541

4642
https://github.com/FHNW-IP5-IP6/GPIOSimulator/blob/dev/docs/Tutorial.adoc
4743

48-
You can generate an html file or any other file format from the `Tutorial.adoc` to make it as readable as possible.
49-
50-
44+
You can generate an `html` file or any other file format from the `Tutorial.adoc` using https://asciidoctor.org[asciidoctor].

0 commit comments

Comments
 (0)