Update README.md

README.md

@@ -1,52 +1,65 @@
-<!-- Header -->
+<!-- Header -->
-<div id="top" align="center">
+<div id="top" align="center">
-  <br />
+  <br />
-  
+  
-  <!-- Logo -->
+  <!-- Logo -->
-  <img src="https://git.zakscode.com/repo-avatars/cfafeecfa694a538cca613976c94203cd48fe506260f6a6b69892545c493b673" alt="Logo" width="200" height="200">
+  <img src="https://git.zakscode.com/repo-avatars/cfafeecfa694a538cca613976c94203cd48fe506260f6a6b69892545c493b673" alt="Logo" width="200" height="200">
-
+
-  <!-- Title -->
+  <!-- Title -->
-  ### Animated Cube
+  ### Animated Cube
-  
+  
-  <!-- Description -->
+  <!-- Description -->
-  Animated 4x4x4 LED cube
+  Animated 4x4x4 LED cube
-
+
-  <!-- Repo badges -->
+
-  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/AnimatedCube/tags&query=$[0].name)](https://git.zakscode.com/ztimson/AnimatedCube/tags)
+  <!-- Repo badges -->
-  [![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/AnimatedCube&query=open_pr_counter)](https://git.zakscode.com/ztimson/AnimatedCube/pulls)
+  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/animated-cube/tags&query=$[0].name)](https://git.zakscode.com/ztimson/animated-cube/tags)
-
+  [![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/animated-cube&query=open_pr_counter)](https://git.zakscode.com/ztimson/animated-cube/pulls)
-</div>
+  [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/animated-cube&query=open_issues_count)](https://git.zakscode.com/ztimson/animated-cube/issues)
-
+
-## Table of Contents
+  <!-- Links -->
-- [Animated Cube](#top)
+
-- [About](#about)
+  ---
-  - [Built With](#built-with)
+  <div>
-- [Demo](#demo)
+    <a href="https://git.zakscode.com/ztimson/animated-cube/releases" target="_blank">Release Notes</a>
-- [License](#license)
+    • <a href="https://git.zakscode.com/ztimson/animated-cube/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
-
+    • <a href="https://git.zakscode.com/ztimson/animated-cube/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
-## About
+  </div>
-
+
-<img src="./gallery/picture.jpg" alt="Logo" width="200" height="200">
+  ---
-<img src="./gallery/Multiplex.svg" alt="Logo" width="200" height="200">
+</div>
-<br />
+
-<br />
+## Table of Contents
-
+- [Animated Cube](#top)
-This repo contains code for running a 4x4x4 (64 total) LED cube. It uses [multiplexing](https://en.wikipedia.org/wiki/Multiplexing) to control all 64 LEDs using only 20 inputs (4 layers + 16 columns).
+  - [About](#about)
-
+    - [Demo](#demo)
-4 LED's are wired into columns using their annode. 16 columns are then wired together in a 4x4 square creating a cube. Each vetical layer has its 16 LED cathodes wired together into a plane. By keeping all inputs disconnected, individual LED's can be turned on by connecting the desired column & layer to the positive and negative respectively providing only one complete path for the electricy to follow. Multiple LEDs can be turned on at once by individually blinking each LED faster than the eye can see. By doing this to render multiple "frames" small animations can be created.
+    - [Built With](#built-with)
-
+  - [License](#license)
-Animations are run using an [Arduino Nano](https://store.arduino.cc/products/arduino-nano).
+
-
+## About
-### Built With
+
-[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino&logoColor=white)](https://www.arduino.cc/)
+<img src="./gallery/picture.jpg" alt="Logo" width="200" height="200">
-[![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=cplusplus)](https://cplusplus.com/)
+<img src="./gallery/Multiplex.svg" alt="Logo" width="200" height="200">
-
+<br />
-## Demo
+<br />
-Video of what it looks like: https://www.youtube.com/watch?v=4pzxR-ZhbJA
+
-
+This repo contains code for running a 4x4x4 (64 total) LED cube. It uses [multiplexing](https://en.wikipedia.org/wiki/Multiplexing) to control all 64 LEDs using only 20 inputs (4 layers + 16 columns).
-<ins>**Disclaimer:** I did not create the video but it is made using the same idea</ins>
+
-
+4 LED's are wired into columns using their annode. 16 columns are then wired together in a 4x4 square creating a cube. Each vetical layer has its 16 LED cathodes wired together into a plane. By keeping all inputs disconnected, individual LED's can be turned on by connecting the desired column & layer to the positive and negative respectively providing only one complete path for the electricy to follow. Multiple LEDs can be turned on at once by individually blinking each LED faster than the eye can see. By doing this to render multiple "frames" small animations can be created.
-## License
+
-Copyright © 2023 Zakary Timson | Available under MIT Licensing
+Animations are run using an [Arduino Nano](https://store.arduino.cc/products/arduino-nano).
-
+
-See the [license](./LICENSE) for more information.
+### Demo
+
+Video of what it looks like: https://www.youtube.com/watch?v=4pzxR-ZhbJA
+
+<ins>**Disclaimer:** I did not create the video but it is made using the same idea</ins>
+
+### 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/)
+
+## License
+Copyright © 2023 Zakary Timson | Available under MIT Licensing
+
+See the [license](./LICENSE) for more information.