Permalink
Browse files

Tidy licensing and documentation a hair.

  • Loading branch information...
1 parent 5844f26 commit 12023786dc52fd3cb50cafad5e5f9ec7acb887dd @jwhite66 committed with Jeremy White Sep 24, 2011
Showing with 747 additions and 4 deletions.
  1. +674 −0 COPYING
  2. +17 −0 LICENSE
  3. +44 −1 README
  4. +1 −2 TODO
  5. +10 −0 drive.c
  6. +1 −1 led.pde
View
Oops, something went wrong.
View
@@ -0,0 +1,17 @@
+All files contained in this git repository, the geled project, are
+Copyright 2011 by Jeremy P White. There are a few exceptions, notably
+for a font file or two; those files have accompanying license files as well.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program in the file called COPYING.
+If not, see <http://www.gnu.org/licenses/>.
View
@@ -1 +1,44 @@
-I should really fill this in...
+This project was written by a Debian Linux user and, as of this date,
+has only every been run on a Debian Linux system.
+
+However, the code is fairly portable. If you're clever and patient,
+you can likely get it to work for you.
+
+The bulk of the Arduino code is contained in led.pde. That should
+work in any Arduino environment, and should get you a running
+driver on your Arduino.
+
+You will need the drive command line utility. Again, the Makefile
+will build it on a Linux system, and maybe other Unix systems.
+
+But it should be possible to compile it on any Unix (including Mac OS X)
+fairly easily. For Windows, it'll be harder; you'll have to manually
+port the serial IO stuff.
+
+On Debian, I have the following relevant packages:
+ ii arduino 0018+dfsg-6 AVR development board IDE and built-in libraries
+ ii avr-libc 1:1.6.8-2 Standard C library for Atmel AVR development
+ ii avrdude 5.10-3 software for programming Atmel AVR microcontrollers
+ ii binutils-avr 2.20.1-1 Binary utilities supporting Atmel's AVR targets
+ ii gcc-avr 1:4.3.5-1 The GNU C compiler (cross compiler for avr)
+ ii arduino 0018+dfsg-6 AVR development board IDE and built-in libraries
+ ii arduino-core
+
+I suspect an apt-get install arduino-core gcc-avr will get you all of those.
+
+I also downloaded the latest Arduino development environment (0022)
+and put a copy of that into the project subdirectory. I edited the
+Makefile to point at that path.
+
+But once that was done, a simple:
+ make && make upload
+programmed the Arduino.
+
+And
+ ./drive init
+ ./drive status
+ ./drive chase
+
+all did interesting things. Note that
+ make reset
+is also quite handy.
View
@@ -1,4 +1,3 @@
-* Set up licensing (GPL v3)
* Provide a flash ram setting to perform init on boot
@@ -9,7 +8,7 @@ If I can figure out how to keep Tone.cpp out of the .pde build,
we could switch to Timer2
---- Never ---
+--- So Long term it might as well be never ---
Right now, we lock step the strings; if you're going to write to
more than 1 string, you have to do them at the same time. That is
not theoretically required; the pins could be inter mingled in the
View
@@ -1,3 +1,13 @@
+/*----------------------------------------------------------------------------
+** drive.c
+** Command line utility for controlling an Arduino running led.pde
+**
+** See usage() for hints on usage.
+**
+** License:
+** GPL v 3 - See LICENSE
+**
+**--------------------------------------------------------------------------*/
#include <stdio.h>
#include <string.h>
#include <unistd.h>
View
@@ -7,7 +7,7 @@
** - Gets commands via serial port
**
** License:
-** LGPL v3
+** GPL v 3 - See LICENSE
**
**--------------------------------------------------------------------------*/
#include "led.h"

0 comments on commit 1202378

Please sign in to comment.