From 95e9156c8bf92dc09f9c89e26084cc409852a606 Mon Sep 17 00:00:00 2001 From: workinghard Date: Fri, 1 May 2015 16:50:43 -0700 Subject: [PATCH 1/5] Update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2dceeb3..71839f8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,20 @@ Cube4Fun ![alt text][logo] -Details coming soon ... +Overview +-------------------------------------- +* Create your own cool 3D animations and tag them +* Upload to your Cube4Fun +* Use the animation-tag from any internet service/device by sending GET/ request to activate animations +* Share your animations with everybody on this site: http://www.cube4fun.net + +Requirements +-------------------------------------- +* MacOS 10.10 or higher +* Arduino Uno or Arduino Mega +* Arduino network shield +* SD card +* Rainbowduino + RGB Cube (check this Wiki for more details Arduino: -------------------------------------- @@ -21,4 +34,4 @@ Rainbowduino: -[logo]: http://cube4fun.net/public/Cube6-128j.png "Logo" \ No newline at end of file +[logo]: http://cube4fun.net/public/Cube6-128j.png "Logo" From 83b22a9bb9309d3acca1f6602c2fab7835460094 Mon Sep 17 00:00:00 2001 From: workinghard Date: Tue, 5 May 2015 15:12:15 -0700 Subject: [PATCH 2/5] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 71839f8..cd050c2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Overview * Use the animation-tag from any internet service/device by sending GET/ request to activate animations * Share your animations with everybody on this site: http://www.cube4fun.net +![alt text][overview1] + Requirements -------------------------------------- * MacOS 10.10 or higher @@ -35,3 +37,4 @@ Rainbowduino: [logo]: http://cube4fun.net/public/Cube6-128j.png "Logo" +[overview1]: http://cube4fun.net/public/Overview-Pic1.png "Overview" From 3a97e2007ed71ea772d99f44036e893d57fc5b3f Mon Sep 17 00:00:00 2001 From: workinghard Date: Tue, 5 May 2015 15:33:27 -0700 Subject: [PATCH 3/5] Update README.md --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cd050c2..383a48a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,35 @@ -Cube4Fun -================== - +# Cube4Fun ![alt text][logo] -Overview --------------------------------------- +## Index + 1. [Overview](#overview) + 2. [Requirements](#requirements) + 3. [Software](##software) + 4. [Hardware](##hardware) + 5. [Arduino controller](#arduino-with-network-shield-and-sd-card) + +## Overview * Create your own cool 3D animations and tag them * Upload to your Cube4Fun * Use the animation-tag from any internet service/device by sending GET/ request to activate animations -* Share your animations with everybody on this site: http://www.cube4fun.net +* Share your animations with everybody on [this site:](http://www.cube4fun.net) ![alt text][overview1] -Requirements --------------------------------------- +## Requirements +### Software * MacOS 10.10 or higher +* Cube4Fun Application (TODO: Link) +* Arduino Image (TODO: Link) +* Rainbowduino Image (TODO: Link) + +### Hardware * Arduino Uno or Arduino Mega * Arduino network shield * SD card -* Rainbowduino + RGB Cube (check this Wiki for more details +* Rainbowduino + RGB Cube [check this Wiki for more details](http://www.seeedstudio.com/wiki/Rainbow_Cube) -Arduino: +Arduino with network shield and sd-card -------------------------------------- ... From 82a27cb704b1f1b37e3ea5ec5bcb0799b607bb5d Mon Sep 17 00:00:00 2001 From: workinghard Date: Tue, 5 May 2015 16:29:13 -0700 Subject: [PATCH 4/5] Update README.md --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 383a48a..c867321 100644 --- a/README.md +++ b/README.md @@ -29,20 +29,19 @@ * SD card * Rainbowduino + RGB Cube [check this Wiki for more details](http://www.seeedstudio.com/wiki/Rainbow_Cube) -Arduino with network shield and sd-card --------------------------------------- - -... - ---- -Rainbowduino: --------------------------------------- - -... - ----- +## Arduino with network shield and sd-card +This piece is a main controller. The main objectives are: + * Handle the communcation like receiving animation requests and process + * Save and read animations from SD card + * Send data to the Rainbowduino +TODO: More details to come +## Rainbowduino: +This piece receives data over I2C protocol and displays it on the cube. +It has also some animations. In case there is no data to display it plays default animations. +There is not much logic on this side. For more details please check the [Rainbowduino Wiki](http://www.seeedstudio.com/wiki/Rainbow_Cube) [logo]: http://cube4fun.net/public/Cube6-128j.png "Logo" From 196f2357486ca73e0d87193aa4ff84d238ce38a2 Mon Sep 17 00:00:00 2001 From: workinghard Date: Tue, 5 May 2015 17:03:39 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c867321..599d910 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ This piece is a main controller. The main objectives are: * Handle the communcation like receiving animation requests and process * Save and read animations from SD card * Send data to the Rainbowduino + TODO: More details to come ## Rainbowduino: @@ -43,6 +44,10 @@ This piece receives data over I2C protocol and displays it on the cube. It has also some animations. In case there is no data to display it plays default animations. There is not much logic on this side. For more details please check the [Rainbowduino Wiki](http://www.seeedstudio.com/wiki/Rainbow_Cube) +## Cube4Fun Application +The application is written in a new apple programming language [Swift](https://developer.apple.com/swift/). The communication part is using the [Poco Library](http://pocoproject.org/) which is written in C++. So it's easy to create a new application for any other device and don't care about TCP/IP communication. + + [logo]: http://cube4fun.net/public/Cube6-128j.png "Logo" [overview1]: http://cube4fun.net/public/Overview-Pic1.png "Overview"