Framework16 LED Matrix Manager

A GUI tool for managing Framework16 LED displays

---

Table of Contents

• Introduction
• Features
• Installation 🚀
• Running ▶️
• Development 🛠️
• Building 📦
• Screenshots 📸
• Contributing 🤝
• License
• Support ☕

---

Introduction

The Framework16 LED Matrix Manager is a GUI application designed to simplify the configuration and control of Framework16 LED displays. This tool is offering a straightforward interface and powerful features for displaying cool stuff on the displays.

---

Features

• Native GUI using QT: Built with a modern QT interface for a responsive and robust user experience.
• Easy Management: Simplified controls for quick and efficient LED display management.
• Advanced Presets: Access and utilize a variety of presets.
• First Class Linux Support: Optimized for GNU/Linux environments, ensuring reliable performance on x86-64 systems.

---

Installation 🚀

Prerequisites

• Nix Package Manager installed on your system.
• Basic understanding of Git and terminal commands.

Steps

1. Clone the Repository:

   git clone https://github.com/FabulousCodingFox/framework16-led-matrix-manager.git
   cd framework16-led-matrix-manager

2. Enter the Development Environment:

   nix develop

   This command initializes a Nix shell with all the necessary dependencies without affecting your host system.

---

Running ▶️

You have two methods to run the program:

• Download Build Artifact:
  Download the pre-built artifact from the repository's releases. This artifact is ready to run on any generic GNU/Linux x86-64 system with QT installed.

• Use Nix Run:
  Launch the application directly using Nix by executing:

  nix run

  This command will build (if necessary) and run the application within the Nix environment.

---

Development 🛠️

To contribute or experiment with new features, start by entering the development environment:

nix develop

This isolated shell ensures that all dependencies are managed appropriately, allowing for a consistent development experience without modifying your main system environment.

---

Building 📦

Below are the build instructions for different platforms:

Linux

For GNU/Linux x86-64 systems, compile the package with:

nix build .#packages.x86_64-linux.default

Windows

Note: The Windows build process is not supported at this time due to limitations with cross-compilation in nixpkgs.qt6. If cross-compilation becomes available in future updates, the following command may be applicable:

nix build .#packages.x86_64-windows.default

---

Screenshots 📸

Below are some placeholder screenshots demonstrating the application’s interface:

---

Contributing 🤝

Contributions are welcome. To propose improvements or add new features, please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top-right of this page.
2. Create a Feature Branch:
   """ git checkout -b feature/your-feature-name """
3. Commit Your Changes:
   """ git commit -m "feat: describe your changes here" """
4. Push to Your Branch:
   """ git push origin feature/your-feature-name """
5. Open a Pull Request: Provide a clear summary of your changes for review.

For additional guidelines, refer to our CONTRIBUTING.md.

---

License

This project is licensed under the Boost Software License. See the LICENSE file for details.

---

Support ☕

If you find this project useful and would like to support its development, please consider contributing via Ko-fi:

Your support is appreciated!

---

For further questions or to provide feedback, please open an issue or contact the maintainers directly.

Happy coding!