Merge pull request #5 from dogeared/processing_build_doc_fix

updated maven build to prepare target folder, but not copy it over

README.md

@@ -9,7 +9,7 @@ Java Library for blink(1)
 
 This builds a fat jar in: `blink1-library/target/blink1-library-jar-with-dependencies.jar`
 
-### Examples
+### Java Examples
 
 Examples that use the library can be found in the blink1-examples module
 
@@ -47,25 +47,35 @@ Setting R(255)G(0)B(0) on blink1
 One or more of the rgb params is not a number between 0 and 255: r(255), g(bad), b(255)
 ```
 
-### Toy / Test Applications written in Processing Java ###
+### Processing Examples
 
-These "toy" or "test" applications for just playing around with your blink(1):
-- BlinkATweet -- Watch real-time Twitter stream for keywords, flash blink(1) when found.  
-Download:
-[(Mac OSX)](https://thingm.com/blink1/downloads/BlinkATweet-mac.zip) /
-[(Windows)](https://thingm.com/blink1/downloads/BlinkATweet-win.zip)
+The Processing IDE can be downloaded and installed from [here](https://processing.org/download/).
 
-- Blink1ColorOrgan -- Sound-reactive program, music-to-color, instant disco!
-Download:
-[(Mac OSX)](https://thingm.com/blink1/downloads/Blink1ColorOrgan-mac.zip) /
-[(Windows)](https://thingm.com/blink1/downloads/Blink1ColorOrgan-win.zip)
+When you build the project, the blink(1) library is organized for use with Processing.
 
-- Blink1ColorPicker -- Play with blink(1) select colors.
-Download:
-[(Mac OSX)](https://thingm.com/blink1/downloads/Blink1ColorPicker-mac.zip),
-[(Windows)](https://thingm.com/blink1/downloads/Blink1ColorPicker-win.zip)
+Simply move the `blink1-processing-examples/target/Blink1` folder to the Processing sketch libraries folder.
 
-- Blink1Test0 -- a very simple random-color app.
-Download:
-[(Mac OSX)](https://thingm.com/blink1/downloads/Blink1Test0-mac.zip) /
-[(Windows)](https://thingm.com/blink1/downloads/Blink1Test0-win.zip)
+By default, the Processing sketch libraries folder can be found at: `~/Documents/Processing/libraries`
+
+Here's an example of how you would get set up to run the Processing examples:
+
+```bash
+mv blink1-processing-examples/target/Blink1 ~/Documents/Processing/libraries
+```  
+
+Once the blink(1) library is in the right place for the Processing IDE, you can open any of the examples found in the
+`blink1-processing-examples` folder.
+
+You can verify that the blink(1) library is properly set up for the Processing IDE by navigating to: 
+**Sketch > Import Library... >** and you'll see: `Blink1` under **Contributed**.
+
+![Blink1](Blink1.png)
+
+If you don't see the above in your own instance of the Processing IDE, make sure that the `Blink1` folder from
+`blink1-processing-examples/target` has been copied to the correct location. You can verify where your Processing
+IDE sketches location is on your local machine by locating the `Sketchbook location` setting in the preferences pane.
+
+![Blink1 preferences](processing_preferences.png)
+
+**NOTE:** If the Processing IDE was already running before you moved the `Blink1` folder over to the `libraries` folder,
+you should exit and restart the Processing IDE.

blink1-processing-examples/pom.xml

@@ -33,24 +33,6 @@
 
     <build>
         <plugins>
-            <plugin>
-                <artifactId>maven-antrun-plugin</artifactId>
-                <version>1.8</version>
-                <executions>
-                    <execution>
-                        <phase>initialize</phase>
-                        <configuration>
-                            <target>
-                                <mkdir dir="target/Blink1/library" />
-                                <delete dir="${processing.libraries.folder}/Blink1"/>
-                            </target>
-                        </configuration>
-                        <goals>
-                            <goal>run</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <groupId>com.coderplus.maven.plugins</groupId>
                 <artifactId>copy-rename-maven-plugin</artifactId>
@@ -75,17 +57,6 @@
                             </fileSets>
                         </configuration>
                     </execution>
-                    <execution>
-                        <id>rename-file</id>
-                        <phase>generate-sources</phase>
-                        <goals>
-                            <goal>rename</goal>
-                        </goals>
-                        <configuration>
-                            <sourceFile>target/Blink1/</sourceFile>
-                            <destinationFile>${processing.libraries.folder}/Blink1/</destinationFile>
-                        </configuration>
-                    </execution>
                 </executions>
             </plugin>
         </plugins>