Pink

pink is a command-line tool inspired by the Unix man command. It displays custom-formatted text pages in the terminal using a subset of HTML-like tags.

Current Working Tested OS's ⚙️

• macOS Ventura 13.6
• FreeBSD 13.2

Features 🎨

• Custom Formatting: Apply styles such as bold, italic, underline, and color to text.
• Pink Tags: Use a subset of HTML-like tags tailored for terminal display.
• Easy to Use: Simply run pink to display a formatted text page.

Installation 🛠️

To install pink, you need to have Rust and Cargo installed on your system. If you haven't already installed Rust, you can do so by following the instructions on the official Rust website.

Once Rust and Cargo are installed, follow these steps to build, install, and set up pink:

1. Clone the repository and navigate to the project directory:

   git clone https://github.com/KatahGii/pink.git
   cd pink

2. Build the project:

   cargo build --release

3. Run the installation script (you might need to give it execute permissions first):

   chmod +x install.sh
   ./install.sh

   This script will:

   • Create the necessary directories.
   • Add the default pink.pink file.
   • Move the compiled binary to a directory in your PATH.

Usage 🚀

To display a formatted text page, run:

pink <filename>

Tag Usage 🏷️

pink utilizes a subset of HTML-like tags, referred to as "pink tags", to apply styles to the text. Here is a brief overview:

• ...: Makes the enclosed text bold.
• ...: Makes the enclosed text italic.
• ...: Underlines the enclosed text.
• ...: Changes the text color to pink.

• ...

  ,

  ...

  ,

  ...

  : Apply heading styles. (more info in the pink.pink file)

Contributing 👥

Contributions are welcome! Feel free to open an issue or submit a pull request.

License 📜

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.