woad.Ruby

Minimal ANSI terminal colour codes, for Ruby

Table of Contents

• Introduction
• Installation
• Components
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Development Dependencies
  • 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 through 3.x.

Installation

Install via gem as in:

gem install woad

or add it to your Gemfile.

Use via require, as in:

require 'woad'

Components

woad.Ruby currently ships the Woad root module and version metadata (require 'woad'). Colour codes, TTY/stream gating, and Windows virtual-terminal opt-in are not implemented in this 0.0.0 skeleton.

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

• <none>

Development Dependencies

• rake
• test-unit

Related projects

• woad.Python
• woad.Rust

License

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