Skip to content

synesissoftware/recls.Ruby

Repository files navigation

recls.Ruby

recursive ls, for Ruby

Gem Version

Introduction

recls stands for recursive ls. The first recls library was a C library with a C++ wrapper. There have been several implementations in other languages. recls.Ruby is the Ruby version.

Table of Contents

  1. Introduction
  2. Installation
  3. Components
  4. Examples
  5. Project Information

Introduction

T.B.C.

Installation & usage

Install using gem install recls-ruby or add it to your Gemfile.

Components

The main components of recls.Ruby are:

  • the Recls module; and
  • the Recls::Entry class

The Recls module

T.B.C.

The Recls::Entry class

T.B.C.

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/recls.Ruby.

Dependencies

None

Dependents

recls.Ruby is used in the libCLImate.Ruby library.

Related projects

License

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

Compatibility

For v2.8.x onwards, recls.Ruby is compatible only with Ruby 2.0+; all other past and current versions work with Ruby 1.9.3+.