🚧 Important: Project Under Development

This project is currently under active development and may undergo frequent changes, updates, and improvements. As such, certain features may be incomplete or subject to modification.

Table of Contents

• Description
• Installation
  • Prerequisites
  • Building and Flashing
    • With PlatformIO CLI
    • With PlatformIO IDE
    • With Arduino IDE
• License
• Contributing
  • Bug Reports
  • Feature Requests
  • Pull Requests
• Authors

Description

Chroniq is an open-source project that aims to create a simple and easy-to-use digital clock, chat system and bus timetable. Chroniq views are fully customizable and users can create their own views (coding skills required).

Installation

Prerequisites

• PlatformIO CLI
• PlatformIO IDE
• Arduino IDE (optional)

Building and Flashing

1. Clone the repository:

   git clone git@github.com:fiatlinuxorg/chroniq.git

2. Change directory to the project root:

   cd chroniq

With PlatformIO CLI

1. Change directory to the firmware folder:

   cd firmware

2. Build the project:

   pio run

3. Flash the project to the board:

   pio run --target upload

4. Done!

With PlatformIO IDE

1. Open the project in the PlatformIO IDE.
2. Click the build button.
3. Click the upload button.
4. Done!

With Arduino IDE

1. Open the project in the Arduino IDE.
2. Click the build button.
3. Click the upload button.
4. Done!

Configuration

Soon.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

Contributing

We welcome contributions from the community to improve this project. If you'd like to contribute, please follow these guidelines:

Bug Reports

If you find a bug, please open an issue and provide as much information as possible. This includes the version of the project and a detailed description of the bug.

Feature Requests

If you'd like to request a new feature, please open an issue and provide a detailed description of the feature you'd like to see or contribute a pull request.

Pull Requests

We welcome pull requests from the community. Before submitting a pull request, please ensure that your code is properly formatted.

If you'd like to contribute, follow these steps:

1. Fork the repository;
2. Create a new branch;
3. Commit your changes to the new branch;
4. Push the new branch to your fork;
5. Open a pull request.

Authors

• RiccardoSegala04
• LanaMirko04
• EtanolotYT