Ansi Code

Ansi codes library for console applications.

Table of Contents

• About the Project
• Features
• Getting Started
  • Prerequisites
  • Installation
    • Install via NuGet Package Manager Console
    • Install via Visual Studio NuGet Package Manager
    • Install via .NET CLI
    • Clone the repo
• Example
• Contributing
• Bug / Issue Reporting
• License
• Contact
• Acknowledgments

Overview

The AnsiCode library is a .NET library that provides a simple and efficient way to work with ANSI escape codes in console applications. It allows developers to easily format text, change colors, and create visually appealing command-line interfaces.

Features

• Text Formatting: Apply various text formatting options such as bold, underline, and italics.
• Color Support: Change text and background colors using ANSI escape codes.

Getting Started

To get started with the AnsiCode library, follow the instructions below to install it in your .NET project.

Prerequisites

• .NET 10.0 or later

Installation

Install via NuGet Package Manager Console

You can install the AnsiCode library using the NuGet Package Manager Console. Open the console and run the following command:

Install-Package TirsvadCLI.AnsiCode

Install via Visual Studio NuGet Package Manager

1. Open your project in Visual Studio.
2. Right-click on your project in the Solution Explorer and select "Manage NuGet Packages".
3. Search for "TirsvadCLI.AnsiCode" in the NuGet Package Manager.
4. Click "Install" to add the library to your project.

Install via .NET CLI

You can also install the AnsiCode library using the .NET CLI. Open a terminal and run the following command:

dotnet add package TirsvadCLI.AnsiCode

Clone the repo

If you want to clone the repository and build the library from source, you can do so using Git. Make sure you have Git installed on your machine. Then, run the following command in your terminal:

git clone git@github.com:TirsvadCLI/Dotnet.Lib.AnsiCode.git

Example

In the example you can see how to use the AnsiCode class.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Bug / Issue Reporting

If you encounter a bug or have an issue to report, please follow these steps:

1. Go to the Issues Page
   Navigate to the GitHub Issues page.

2. Click "New Issue"
   Click the green "New Issue" button to create a new issue.

3. Provide Details

• Title: Write a concise and descriptive title for the issue.
• Description: Include the following details:
  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Environment details (e.g., OS, .NET version, etc.).
• Attachments: Add screenshots, logs, or any other relevant files if applicable.

4. Submit the Issue
   Once all details are filled in, click "Submit new issue" to report it.

License

Distributed under the GPL-3.0 License.

Contact

Jens Tirsvad Nielsen - LinkedIn