Skip to content

Commit

Permalink
Update README, and .gitattributes
Browse files Browse the repository at this point in the history
  • Loading branch information
rangerscience committed Aug 3, 2019
1 parent 8023d2e commit b331fc3
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
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
30 changes: 30 additions & 0 deletions README.md
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 :)

0 comments on commit b331fc3

Please sign in to comment.