diff --git a/README.md b/README.md index d9a200d..2bad89c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,52 @@ -# Animated Cube + +
+
+ + + Logo -Arduino code to animate a 4x4x4 LED matrix using [multiplexing](https://en.wikipedia.org/wiki/Multiplexing) + + ### Animated Cube + + + Animated 4x4x4 LED cube -64 LEDs have had each anode wired together in columns and each cathode wired in planes. By controling which column & plane has power an individual LED can be controlled. Using this method called _multiplexing_, several LEDs can be flashed on and off to create animations. + + [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/291st&query=open_pr_counter)](https://git.zakscode.com/ztimson/291st/pulls) -![led-cube](./gallery/picture.jpg) +
+ +## Table of Contents +- [Animated Cube](#top) +- [About](#about) + - [Built With](#built-with) +- [Demo](#demo) +- [License](#license) + +## About + +Logo +Logo +
+
+ +This repo contains code for running a 4x4x4 (64 total) [multiplexed](https://en.wikipedia.org/wiki/Multiplexing) LED cube. + +4 LED's are wired into columns using their annode. 16 columns are then wired together creating the cube, connecting each layer (16 LEDs) together by their cathode. By keeping each layer & column disconnected, individual LED's can be toggled on by connecting the desired column & layer. Multiple LEDs can be turned on at once by individually blinking each LED faster than the eye can see. By rendering multiple "frames" in quick succession patterns can be created on the cube. + +Animations are run using an [Arduino Nano](https://store.arduino.cc/products/arduino-nano). + +### Built With +[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino&logoColor=white)](https://www.arduino.cc/) +[![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=cplusplus)](https://cplusplus.com/) + +## Demo + +Video of what it looks like: https://www.youtube.com/watch?v=4pzxR-ZhbJA + +**Disclaimer:** I did not create the video but it is made using the same idea + +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information.