Zig Colors: Beautiful Terminal Colors for Zig 🌈

Table of Contents

• Overview
• Installation
• Usage
• Features
• Examples
• Contributing
• License
• Contact

Overview

Zig Colors offers a vibrant set of terminal colors for Zig applications. With a focus on simplicity and cross-platform compatibility, this library allows developers to easily style console output. Whether you want to enhance your terminal user interface (TUI) or just make your logs more colorful, Zig Colors has you covered.

For the latest releases, visit Releases.

Installation

To get started with Zig Colors, download the latest release from the Releases section. After downloading, follow these steps:

1. Unzip the downloaded file.
2. Navigate to the directory where you extracted the files.
3. Execute the installation script.

This will set up Zig Colors in your development environment.

Usage

Using Zig Colors is straightforward. First, import the library into your Zig project. Here’s a simple example:

const std = @import("std");
const colors = @import("zig_colors");

pub fn main() void {
    std.debug.print("{}\n", .{colors.red("This text is red!")});
    std.debug.print("{}\n", .{colors.green("This text is green!")});
    std.debug.print("{}\n", .{colors.blue("This text is blue!")});
}

In this example, we import the zig_colors module and use its functions to print colored text to the console.

Features

• Cross-Platform Support: Works seamlessly on Windows, macOS, and Linux.
• ANSI Colors: Utilizes ANSI escape codes for rich color support.
• Hex and RGB Colors: Supports both hex and RGB color formats for more customization.
• Easy Integration: Simple API that integrates smoothly with existing Zig projects.
• TUI Friendly: Perfect for creating terminal user interfaces.

Examples

Here are a few more examples to illustrate the capabilities of Zig Colors:

Basic Color Usage

const std = @import("std");
const colors = @import("zig_colors");

pub fn main() void {
    std.debug.print("{}\n", .{colors.yellow("This text is yellow!")});
    std.debug.print("{}\n", .{colors.cyan("This text is cyan!")});
}

Custom RGB Colors

You can also define custom colors using RGB values:

const std = @import("std");
const colors = @import("zig_colors");

pub fn main() void {
    const customColor = colors.rgb(255, 165, 0); // Orange
    std.debug.print("{}\n", .{customColor("This text is orange!")});
}

Using Hex Colors

For those who prefer hex codes:

const std = @import("std");
const colors = @import("zig_colors");

pub fn main() void {
    const hexColor = colors.hex("#FF5733"); // A shade of red
    std.debug.print("{}\n", .{hexColor("This text is red from hex!")});
}

Contributing

Contributions are welcome! If you want to improve Zig Colors, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes.
4. Submit a pull request.

Please ensure your code follows the project's style guidelines and includes tests where applicable.

License

Zig Colors is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or suggestions, feel free to reach out:

• GitHub: LeonDev13
• Email: [email protected]

For the latest updates and releases, check the Releases section.