-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8023d2e
commit b331fc3
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
*.img filter=lfs diff=lfs merge=lfs -text | ||
*.zip filter=lfs diff=lfs merge=lfs -text |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# About | ||
|
||
This is code to control the lights of the Butterfly of https://www.facebook.com/TPATB2019 | ||
|
||
A Raspberry Pi (see that folder's readme for more) hosts and control server, renders frames, | ||
and pushes those frames to connected devices. | ||
|
||
Connected Arduinos (well, technically, the Butterfly uses Teensyduinos) then push the frames | ||
to the LEDs. | ||
|
||
The server code is in Ruby. | ||
|
||
# Setup | ||
|
||
You will need Git LFS: https://git-lfs.github.com/ - *before* you clone the repo. | ||
You will need Ruby (and Bundler). RVM is recommended. | ||
|
||
# Contributing | ||
|
||
Use branches, forks, and pull requests! Don't commit to master. | ||
|
||
# Dev Guide | ||
|
||
Instructions and files for setting up the hardware should go into the corresponding folders. | ||
|
||
`server/lib/effects` contains the various basic effects out of which patterns can be made. Please add more! | ||
`server/lib/compositions` contains preset patterns. Please add more! | ||
`server/lib/serial` contains the code for pushing data to the Arduinos over serial connections (currently USB serial) | ||
|
||
RSpec for testing. All tests currently pass, please keep it that way :) |