Skip to content

Commit

Permalink
Cleaned up ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonacox committed Jul 4, 2020
1 parent 69a07a9 commit e4abd14
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# TM1637TinyDisplay Test Sketch
# TM1637TinyDisplay Examples

## Test Sketch
The [TM1637Test.ino](TM1637Test/TM1637Test.ino) sketch will test the library functions.

## Demo Sketch

The [TM1637Demo.ino](TM1637Demo/TM1637Demo.ino) sketch will demonstrate the library functions
and play an extended set of animation sequences. The animations were built with the [Animator Tool](https://jasonacox.github.io/TM1637TinyDisplay/examples/7-segment-animator.html) referenced below.

## Animation

### 7-Segment LED Display Animator Tool

![Animator Tool](AnimatorToolThumb.png)

This tool will allow the user to visually toggle on/off LEDs in a 4-digit
Expand All @@ -24,7 +23,6 @@ into your sketch.
[https://jasonacox.github.io/TM1637TinyDisplay/examples/7-segment-animator.html](https://jasonacox.github.io/TM1637TinyDisplay/examples/7-segment-animator.html)

### Animation showAnimation() Function

The showAnimation() function projects a sequence of frames (patterns) onto the display. This works by provide the function a multi-dimensional array of patterns.

As mentioned above, you can use the javascript based interactive [7-Segment LED Animator Tool](https://jasonacox.github.io/TM1637TinyDisplay/examples/7-segment-animator.html) to help build your animation. The source code is in this single-file HTML: [7-segment-animator.html](7-segment-animator.html) which you can run from your local file system or a website. This tool will let you set up the LED sequences you want, save each frame and copy the final code (a static array) directly into your sketch to use for the `showAnimation(data, frames, timing)` function. Here is an example implementation:
Expand Down

0 comments on commit e4abd14

Please sign in to comment.