Merge pull request #46 from FHNW-IP5-IP6/dev

Dev to master

Author: imanesso

.gitignore

@@ -80,4 +80,8 @@ scenicView.properties
 
 # NetBeans
 .nb-gradle/
-nbproject/
+nbproject/
+
+# jbaettig's Section
+docs/*.pdf
+/log/*

README.adoc

@@ -1,2 +1,44 @@
 = GIOSimulator
 
+*Creating GPIO projects in Java on the Raspberry Pi has never been this easy!*
+
+== What is the GPIOSimulator
+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.
+
+== Main Features
+* Beginner friendly component classes for easy usage of common sensors and actuators in Java
+
+* Compatibility with the Grove Base Hat
+
+* Compatibility with Grove Sensors and Actuators
+
+* A rich tutorial which explains all components
+
+* A sample project that shows how the components can work together
+
+== Installation
+Download the `jar` file from the releases: + 
+https://github.com/FHNW-IP5-IP6/GPIOSimulator/releases/
+
+Add the file to the resources of your project and add a new gradle dependency:
+
+[source]
+----
+repositories {
+    mavenCentral()
+    flatDir {
+        dirs 'build/libs'
+    }
+}
+
+dependencies {
+    implementation name: 'GPIOSimulator-0.1'
+}
+----
+
+== Complete Tutorial
+Visit the following page for a complete tutorial:
+
+https://github.com/FHNW-IP5-IP6/GPIOSimulator/blob/dev/docs/Tutorial.adoc
+
+You can generate an `html` file or any other file format from the `Tutorial.adoc` using https://asciidoctor.org[asciidoctor].

build.gradle

@@ -1,19 +1,21 @@
 plugins {
-	id 'java'
+    id 'java'
     id 'org.asciidoctor.jvm.convert' version '3.1.0'
     id 'org.asciidoctor.jvm.pdf' version '3.1.0'
 }
 
 group 'ch.fhnw'
-version '0.1'
+version '1.0'
 
 repositories {
-	jcenter()
+    jcenter()
     mavenCentral()
-	maven {
-		url "https://oss.sonatype.org/content/repositories/snapshots/"
-	}
-
+    maven {
+        url "https://oss.sonatype.org/content/repositories/snapshots/"
+    }
+    maven {
+        url "https://jitpack.io"
+    }
 }
 
 
@@ -26,49 +28,64 @@ sourceSets {
 }
 
 compileJava {
-    options.encoding    = 'UTF-8'
-    sourceCompatibility = JavaVersion.VERSION_11
-    targetCompatibility = JavaVersion.VERSION_11
+    options.encoding = 'UTF-8'
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
 }
 
 dependencies {
-	implementation 'com.pi4j:pi4j-core:1.4-SNAPSHOT'
+    implementation 'com.pi4j:pi4j-core:1.2'
+    implementation 'com.pi4j:pi4j-device:1.2'
+    implementation 'com.github.Hopding:JRPiCam:v1.1.1'
+    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.13.2'
+    compile "uk.co.caprica:picam:2.0.2"
 
-	testImplementation('org.junit.jupiter:junit-jupiter:5.6.0')
+    testImplementation('org.junit.jupiter:junit-jupiter:5.6.0')
 }
 
 test {
-	useJUnitPlatform()
-	testLogging {
-		events "passed", "skipped", "failed"
-	}
+    useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
 }
 
 
 asciidoctorj {
     modules {
-       diagram.version '1.5.18'
+        diagram.version '1.5.18'
     }
 }
 
 asciidoctor {
-  sourceDir  file('docs')
-  sources {
-    include 'documentation.adoc','syntax.adoc'
-  }
-  outputDir  file('build/docs')
-  attributes  'source-highlighter': 'coderay',
-              'coderay-linenums-mode': 'table',
-              'sourcedir': "${projectDir}/src/main/java",
-              'targeted-env': 'Sample'
+    sourceDir file('docs')
+    sources {
+        include 'documentation.adoc', 'syntax.adoc'
+    }
+    outputDir file('build/docs')
+    attributes 'source-highlighter': 'coderay',
+            'coderay-linenums-mode': 'table',
+            'sourcedir': "${projectDir}/src/main/java",
+            'targeted-env': 'Sample'
 }
 
 asciidoctorPdf {
-  sourceDir 'docs'
+    sourceDir 'docs'
 
-  asciidoctorj {
-    attributes 'source-highlighter' : 'coderay',
-               'sourcedir': "${projectDir}/src/main/java",
-               'targeted-env': 'PDF Sample'
-  }
-}
+    asciidoctorj {
+        attributes 'source-highlighter': 'coderay',
+                'sourcedir': "${projectDir}/src/main/java",
+                'targeted-env': 'PDF Sample'
+    }
+}
+
+jar {
+    //exclude examples for using it like an API, but then manifest also has to be removed
+    exclude("fhnwexamples/*")
+    //manifest {
+    //    attributes "Main-Class": "fhnwexamples.Examples"
+    //}
+    from {
+        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+    }
+}