woad.Ruby

Minimal ANSI terminal colour codes, for Ruby

Table of Contents

• Introduction
• Installation
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Efferent (fan-out)
      • Runtime Dependencies (aka "Normal Dependencies")
      • Development Dependencies
    • Afferent (fan-in)
      • Runtime dependents
      • Development dependents
  • Related projects
  • License

Introduction

woad provides the smallest useful set of fixed ANSI SGR colour sequences for library authors. It is not a console or TUI framework.

woad.Ruby is the Ruby implementation. It supports Ruby 2.0+.

It has no dependencies on any other non-standard library.

Installation

Install via gem as in:

gem install woad

or add it to your Gemfile.

Use via require, as in:

require 'woad'

puts "#{Woad::FG_GREEN}ok#{Woad::RESET}"

Components

woad.Ruby ships SGR string constants (RESET, FG_*, BG_*, including bright variants). TTY/stream gating and Windows virtual-terminal opt-in are not implemented yet.

Examples

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/woad.Ruby.

Dependencies

Efferent (fan-out)

Libraries upon which woad.Ruby depends:

Runtime Dependencies (aka "Normal Dependencies")

• <none>;

Development Dependencies

• rake;
• test-unit;

Afferent (fan-in)

Projects that depend on woad.Ruby:

Runtime dependents

• <none>;

Development dependents

• <none>;

Related projects

• woad (C);
• woad.Python;
• woad.Rust;

License

woad.Ruby is released under the 3-clause BSD license. See LICENSE for details.