Browse Source

Improved readme.

Thomas Buck 12 years ago
parent
commit
535652db64
1 changed files with 12 additions and 6 deletions
  1. 12
    6
      README.md

+ 12
- 6
README.md View File

2
 
2
 
3
 8x8x8 Single Color LED Cube built with an AtMega32.
3
 8x8x8 Single Color LED Cube built with an AtMega32.
4
 
4
 
5
+## Building the Software
6
+
7
+You need an AVR GCC Toolchain (eg. WinAVR) to compile both AVR firmwares. You need a C Compiler for your computer (only gcc tested, others should work) and a recent JDK with Java3D to build the PC Software, CubeControl. It should work on Windows, Mac OS X and Linux. To compile a project, just enter it's directory and run make. If you get errors compiling CubeControl, try changing the hard-coded JDK paths in the libSerial makefile, found in CubeControl/libSerial.
8
+
5
 ## Hardware
9
 ## Hardware
6
 
10
 
7
 This LED-Cube uses an AtMega32 for displaying animations and an AtMega8 for Audio Visualizations. I first built the Circuit on a 160x100mm hole-grid board. This was very cumbersome, so I created a dual-sided PCB Layout with SMD Parts. You can find this Layout and the Schematic in the Hardware folder, as PNGs and Eagle files. There's also a partlist.
11
 This LED-Cube uses an AtMega32 for displaying animations and an AtMega8 for Audio Visualizations. I first built the Circuit on a 160x100mm hole-grid board. This was very cumbersome, so I created a dual-sided PCB Layout with SMD Parts. You can find this Layout and the Schematic in the Hardware folder, as PNGs and Eagle files. There's also a partlist.
8
 
12
 
9
-## CubeFirmware
13
+## Software
14
+
15
+### CubeFirmware
10
 
16
 
11
 CubeFirmware controls the AtMega32, which in turn displays images and communicates over USB. It's in the CubeFirmware folder. Compile with avr-gcc, using the makefile (just run 'make').
17
 CubeFirmware controls the AtMega32, which in turn displays images and communicates over USB. It's in the CubeFirmware folder. Compile with avr-gcc, using the makefile (just run 'make').
12
 
18
 
13
-## AudioFirmware
19
+### AudioFirmware
14
 
20
 
15
-This firmware controls the AtMega8, which interfaces the MSGEQ7 to get sound data. It is addressed by the CubeFirmware as a TWI-Slave.
21
+This firmware controls the AtMega8, which interfaces the MSGEQ7 to get sound data. It is addressed by the CubeFirmware as a TWI-Slave. Compile it like CubeFirmware.
16
 
22
 
17
-## CubeControl
23
+### CubeControl
18
 
24
 
19
 CubeControl is a PC software, written in Java and mostly platform-independent, to create Animations for the Cube and send them to it. It depends on [Java3D](http://www.oracle.com/technetwork/java/javase/tech/index-jsp-138252.html) to display a rotatable, clickable 3D View of the LED-Cube. It comes with it's own Serial Library to communicate with the Cube. Compile it with the makefile. You need a working javac and gcc in your Path. To compile under windows get something like [MinGW](http://www.mingw.org/) or try Microsofts compiler.
25
 CubeControl is a PC software, written in Java and mostly platform-independent, to create Animations for the Cube and send them to it. It depends on [Java3D](http://www.oracle.com/technetwork/java/javase/tech/index-jsp-138252.html) to display a rotatable, clickable 3D View of the LED-Cube. It comes with it's own Serial Library to communicate with the Cube. Compile it with the makefile. You need a working javac and gcc in your Path. To compile under windows get something like [MinGW](http://www.mingw.org/) or try Microsofts compiler.
20
 
26
 
21
-## HardwareEmulator
27
+### HardwareEmulator
22
 
28
 
23
 Run this in a Unixoid OS to test CubeControls up-/download capabilites.
29
 Run this in a Unixoid OS to test CubeControls up-/download capabilites.
24
 
30
 
25
-## UploadTest
31
+### UploadTest
26
 
32
 
27
 Allows you to send test data or aniamtions saved by CubeControl to the Cube.
33
 Allows you to send test data or aniamtions saved by CubeControl to the Cube.
28
 
34
 

Loading…
Cancel
Save