Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jschneibel authored Apr 22, 2019
1 parent 721209b commit 96e6656
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# tiny-tune
Plays Arduino tunes with minimal memory consumption. Allows for other tasks to be executed simultaneously.
This is a sample program that plays a tune on an Arduino. The program has been optimized to consume
as little SRAM (variable memory) as possible for long melodies. Furthermore, additional code can
be executed while the tune is played.

In order to run the program, compile and upload the following files to your Arduino:
- tiny-tune.ino
- tunes.ino
- pitches.h
- libraries/ArduinoThread (library by Ivan Seidel)

Use playTune() to start playing the tune.
Use cancelTune() to stop playing the tune.
Edit getTuneData() in tunes.ino to change the sample tune or add your own tunes.

0 comments on commit 96e6656

Please sign in to comment.