update readme files for examples

satori-com · Apr 5, 2018 · 2a2d8aa · 2a2d8aa
1 parent a24263f
commit 2a2d8aa
Show file tree

Hide file tree

Showing 31 changed files with 64 additions and 127 deletions.
diff --git a/build.gradle b/build.gradle
@@ -163,7 +163,7 @@ subprojects {
       println "creating default project structure for project '${project.name}'..."
 
       // create directories for all source sets
-      sourceSets.all { sourceSet ->
+      sourceSets.forEach { sourceSet ->
         sourceSet.java.srcDirs.forEach {
           def pathToCreate = new File(it, pckgDir)
           println "creating sources path for '${sourceSet.name}': '$pathToCreate'"

diff --git a/mods-examples/barrier-queue/build.gradle b/mods-examples/barrier-queue/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "barrier queue"
+
 mainClassName = 'com.satori.mods.examples.App'
 applicationName = projectDir.name
 

diff --git a/mods-examples/barrier-queue/docs/files/diagram.png b/mods-examples/barrier-queue/docs/files/diagram.png
diff --git a/mods-examples/barrier-queue/readme.md b/mods-examples/barrier-queue/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'barrier queue' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/barrier/build.gradle b/mods-examples/barrier/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "barrier"
+
 mainClassName = 'com.satori.mods.examples.App'
 applicationName = projectDir.name
 

diff --git a/mods-examples/barrier/docs/files/diagram.png b/mods-examples/barrier/docs/files/diagram.png
diff --git a/mods-examples/barrier/readme.md b/mods-examples/barrier/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'barrier' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/big-blue-bus/build.gradle b/mods-examples/big-blue-bus/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "big blue bus"
+
 mainClassName = 'com.satori.mods.examples.BigBlueBus'
 applicationName = projectDir.name
 

diff --git a/mods-examples/big-blue-bus/docs/files/diagram.png b/mods-examples/big-blue-bus/docs/files/diagram.png
diff --git a/mods-examples/big-blue-bus/readme.md b/mods-examples/big-blue-bus/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'big blue bus' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/clock/build.gradle b/mods-examples/clock/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "clock"
+
 mainClassName = 'com.satori.mods.examples.ClockApp'
 applicationName = projectDir.name
 

diff --git a/mods-examples/clock/docs/files/diagram.png b/mods-examples/clock/docs/files/diagram.png
diff --git a/mods-examples/clock/readme.md b/mods-examples/clock/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'clock' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/clock2/Dockerfile b/mods-examples/clock2/Dockerfile
diff --git a/mods-examples/clock2/build.gradle b/mods-examples/clock2/build.gradle
@@ -1,5 +1,4 @@
 apply plugin: 'application'
-apply from: '../examples.gradle'
 
 mainClassName = 'com.satori.mods.examples.ClocksApp2'
 applicationName = projectDir.name

diff --git a/mods-examples/clock2/readme.md b/mods-examples/clock2/readme.md
diff --git a/mods-examples/composition-drawer/build.gradle b/mods-examples/composition-drawer/build.gradle
@@ -1,5 +1,3 @@
-import com.satori.libs.composition.drawer.*
-
 buildscript{
   repositories {
     mavenCentral()
@@ -8,7 +6,7 @@ buildscript{
     }
   }
   dependencies {
-    classpath "com.satori:satori-libs-composition-drawer:0.5.13-SNAPSHOT"
+    classpath "com.satori:satori-libs-composition-drawer:0.5.14-SNAPSHOT"
   }
 }
 
@@ -24,7 +22,7 @@ generateCode.dependsOn generateCompositionImage
 
 configurations{compositionDrawer}
 dependencies {
-  compositionDrawer "com.satori:satori-libs-composition-drawer:0.5.13-SNAPSHOT"
+  compositionDrawer "com.satori:satori-libs-composition-drawer:0.5.14-SNAPSHOT"
 }
 
 task generateCompositionImage2(type: JavaExec) {

diff --git a/mods-examples/examples.gradle b/mods-examples/examples.gradle
@@ -1,5 +1,25 @@
 import groovy.text.*
 
+buildscript{
+  repositories {
+    mavenCentral()
+    maven {
+      url('https://oss.sonatype.org/content/repositories/snapshots/')
+    }
+  }
+  dependencies {
+    classpath "com.satori:satori-libs-composition-drawer:0.5.14-SNAPSHOT"
+  }
+}
+
+task generateCompositionImage(type: GenerateCompositionDiagramTask) {
+  group "codegen"
+  cfgPath = file("res/com/satori/mods/resources/config.json")
+  imgPath = file("docs/files/diagram.png")
+  blockWidth = 220
+  blockHeight = 45
+}
+
 startScripts {
   //applicationName = 'app'
   defaultJvmOpts = ["-server", "-d64"]
@@ -18,6 +38,9 @@ task generateReadme(type: TransformTask) {
   output file("readme.md")
   outputs.upToDateWhen { false }
 }
+generateReadme.dependsOn generateCompositionImage
+generateCode.dependsOn generateReadme
+
 
 task generateLogProperties(type: TransformTask) {
   group 'codegen'

diff --git a/mods-examples/hello-world/Dockerfile b/mods-examples/hello-world/Dockerfile
diff --git a/mods-examples/hello-world/build.gradle b/mods-examples/hello-world/build.gradle
@@ -1,5 +1,4 @@
 apply plugin: 'application'
-apply from: '../examples.gradle'
 
 mainClassName = 'com.satori.mods.examples.HelloWorldApp'
 applicationName = projectDir.name

diff --git a/mods-examples/hello-world/readme.md b/mods-examples/hello-world/readme.md
diff --git a/mods-examples/nws-usa-alerts/build.gradle b/mods-examples/nws-usa-alerts/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "nws usa alerts"
+
 mainClassName = 'com.satori.mods.examples.NwsUsaAlerts'
 applicationName = projectDir.name
 

diff --git a/mods-examples/nws-usa-alerts/docs/files/diagram.png b/mods-examples/nws-usa-alerts/docs/files/diagram.png
diff --git a/mods-examples/nws-usa-alerts/readme.md b/mods-examples/nws-usa-alerts/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'nws usa alerts' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/queue/build.gradle b/mods-examples/queue/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "queue"
+
 mainClassName = 'com.satori.mods.examples.App'
 applicationName = projectDir.name
 

diff --git a/mods-examples/queue/docs/files/diagram.png b/mods-examples/queue/docs/files/diagram.png
diff --git a/mods-examples/queue/readme.md b/mods-examples/queue/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'queue' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/readme.template.md b/mods-examples/readme.template.md
@@ -5,6 +5,9 @@ def appScript = project.startScripts.applicationName
 def appName = project.applicationName
 def projName = project.name
 %>-->
+## '<%=project.description%>' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist

diff --git a/mods-examples/rtm-filter/build.gradle b/mods-examples/rtm-filter/build.gradle
@@ -1,6 +1,8 @@
 apply plugin: 'application'
 apply from: '../examples.gradle'
 
+description "rtm filter"
+
 mainClassName = 'com.satori.mods.examples.NwsUsaAlerts'
 applicationName = projectDir.name
 

diff --git a/mods-examples/rtm-filter/docs/files/diagram.png b/mods-examples/rtm-filter/docs/files/diagram.png
diff --git a/mods-examples/rtm-filter/readme.md b/mods-examples/rtm-filter/readme.md
@@ -1,4 +1,7 @@
 <!-- generated, do not modify -->
+## 'rtm filter' example
+![diagram](docs/files/diagram.png)
+
 ##### build app
 ```
 gradle installDist