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:

Clone the repository and navigate to the project directory:
```
git clone https://github.com/KatahGii/pink.git
cd pink
```
Build the project:
```
cargo build --release
```
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.

A lightweight terminal tool to manage processes in Unix machines.

TTV v0.0.1 TTV (term-task-viewer) is a lightweight tool to view and manage active processes in Unix machines. It provides an easy interface with vim-l

9 Aug 29, 2023

Reviving the Research Edition Unix speak command

This repository contains the source code of Unix speak program that appeared in the Third (1973) to Sixth (1975) Research Unix editions, slightly adjusted to run on a modern computer. Details on the code's provenance and the methods employed for reviving it can be found in this blog post.

31 Jul 27, 2022

fcp is a significantly faster alternative to the classic Unix cp(1) command

A significantly faster alternative to the classic Unix cp(1) command, copying large files and directories in a fraction of the time.

532 Jan 3, 2023

xcp is a (partial) clone of the Unix cp command. It is not intended as a full replacement

xcp is a (partial) clone of the Unix cp command. It is not intended as a full replacement, but as a companion utility with some more user-friendly feedback and some optimisations that make sense under certain tasks (see below).

310 Jan 5, 2023

A command line tool written in Rust and designed to be a modern build tool + package manager for C/C++ projects.

CCake CCake is a command line tool written in Rust and designed to be a modern build tool + package manager for C/C++ projects. Goals To be easily und

4 Oct 24, 2022

Rust File Management CLI is a command-line tool written in Rust that provides essential file management functionalities. Whether you're working with files or directories, this tool simplifies common file operations with ease.

Rust FileOps Rust File Management CLI is a command-line tool written in Rust that provides essential file management functionalities. Whether you're w