Merge pull request #102 from OpenSourceLightshows/kurt/readme-helios-…

…engine-convert

kurt/readme-helios-engine-convert

HeliosCLI/README.md

@@ -1,8 +1,8 @@
-# Helios Vortex Project
+# Helios Engine CLI
 
 ## CLI Tool
 
-The Helios Vortex project includes a powerful Command Line Interface (CLI) tool that allows users to interact with and test the firmware without the need for physical hardware. This tool is invaluable for development, testing, and pattern creation.
+The Helios Engine project includes a powerful Command Line Interface (CLI) tool that allows users to interact with and test the firmware without the need for physical hardware. This tool is invaluable for development, testing, and pattern creation.
 
 ### Key CLI Features
 
@@ -47,7 +47,7 @@ These commands can be chained together to create complex input sequences for tes
 
 ## Pattern Visualization
 
-The Helios Vortex project includes tools for generating visual representations of patterns in both PNG and SVG formats. These visualizations are useful for documentation, analysis, and sharing pattern designs.
+The Helios Engine project includes tools for generating visual representations of patterns in both PNG and SVG formats. These visualizations are useful for documentation, analysis, and sharing pattern designs.
 
 ### Generating BMPs and PNG
 
@@ -95,7 +95,7 @@ You can customize the pattern visualization process by modifying the following f
 
 These visualizations are particularly useful for:
 
-- Documenting the available patterns in the Helios Vortex project.
+- Documenting the available patterns in the Helios Engine project.
 - Analyzing pattern behavior and timing.
 - Sharing pattern designs with the community.
 - Creating visual aids for user manuals or promotional materials.

README.md

@@ -1,11 +1,14 @@
-# Helios Vortex Project
+# Helios Engine
 
 ## Introduction
 
-![Build](https://github.com/Unreal-Dan/HeliosVortex/actions/workflows/build.yml/badge.svg?branch=master)
-[![Latest Release](https://img.shields.io/github/v/tag/Unreal-Dan/HeliosVortex?label=Latest%20Release)](https://github.com/Unreal-Dan/HeliosVortex/releases/latest)
+![Build](https://github.com/OpenSourceLightshows/HeliosEngine/actions/workflows/build.yml/badge.svg?branch=master)
+[![Latest Release](https://img.shields.io/github/v/tag/OpenSourceLightshows/HeliosEngine?label=Latest%20Release)](https://github.com/OpenSourceLightshows/HeliosEngine/releases/latest)
+
+Welcome to the Helios Engine project! This repository contains the firmware for the Helios microlight, designed specifically for the ATTiny85 chip. The firmware is capable of controlling a single LED to produce a variety of patterns and effects.
+
+The Helios Engine is based on the [VortexEngine](https://github.com/StoneOrbits/VortexEngine), to accommodate for the ATTiny85's limited resources, in other words, Helios is a ***twist*** on Vortex Engine.
 
-Welcome to the Helios Vortex project! This repository contains the firmware for the Helios microlight, designed specifically for the ATTiny85 chip. The firmware is capable of controlling a single LED to produce a variety of patterns and effects.
 
 ## Features
 
@@ -45,7 +48,7 @@ The project uses GitHub Actions for continuous integration. The workflow defined
 
 ## Uploading to ATTiny85
 
-To upload the Helios Vortex firmware to an ATTiny85 microcontroller, follow these steps:
+To upload the Helios Engine firmware to an ATTiny85 microcontroller, follow these steps:
 
 ### Prerequisites
 
@@ -93,7 +96,7 @@ This will compile the firmware if necessary and then upload it to the ATTiny85.
 
 ## Clock Speed and Compilation
 
-The Helios Vortex firmware is designed to work with ATTiny85 chips running at either 8 MHz or 16 MHz. The default clock speed is set to 8 MHz, but this can be easily changed in the Makefile.
+The Helios Engine firmware is designed to work with ATTiny85 chips running at either 8 MHz or 16 MHz. The default clock speed is set to 8 MHz, but this can be easily changed in the Makefile.
 
 ### Setting the Clock Speed
 

tests/README.md

@@ -1,8 +1,8 @@
-# Helios Vortex Testing
+# Helios Engine Testing
 
 ## Testing
 
-The Helios Vortex project includes a comprehensive test suite to ensure firmware reliability and functionality. The tests are designed to cover various aspects of the system, including pattern generation, color management, and user input handling.
+The Helios Engine project includes a comprehensive test suite to ensure firmware reliability and functionality. The tests are designed to cover various aspects of the system, including pattern generation, color management, and user input handling.
 
 ### Test Structure
 
@@ -54,7 +54,7 @@ To create a new test:
 
 ### Writing Tests
 
-Writing effective tests is crucial for maintaining the reliability of the Helios Vortex firmware. Here's a guide on how to write tests:
+Writing effective tests is crucial for maintaining the reliability of the Helios Engine firmware. Here's a guide on how to write tests:
 
 #### Test File Structure
 
@@ -132,7 +132,7 @@ MENU
 5. **Update tests with changes**: When you modify the firmware, update or add tests accordingly.
 6. **Comment complex tests**: If a test is particularly complex, add comments to explain its purpose and structure.
 
-By following these guidelines, you can create a robust test suite that helps maintain the quality and reliability of the Helios Vortex firmware.
+By following these guidelines, you can create a robust test suite that helps maintain the quality and reliability of the Helios Engine firmware.
 
 ### Recording Tests
 
@@ -200,4 +200,4 @@ These scripts facilitate sharing test cases and maintaining a consistent test su
 
 The project uses GitHub Actions for continuous integration. The workflow defined in `.github/workflows/build.yml` automatically builds the project and runs the test suite on every push and pull request to the main branch.
 
-Thank you for your interest in the Helios Vortex project!
+Thank you for your interest in the Helios Engine project!