<commit_before>= Ratch -- Ruby-based Batch Scripts

* home: http://rubyworks.github.com/ratch
* work: http://github.com/rubyworks/ratch


== Introduction

Ratch is Ruby-based DSL for building batch scripts. It's intent
is to ease the burden of batch script writers by supplementing
the standard ruby environment to be more condusive to the needs
of batch scripting.

In addition to using Ratch to write stand-alone batch scripts,
it makes a very powerful library for other applications that
require batch-like functionality. In general any program that
access the file system extensively could benifit from it's use.


== Usage

=== Batch Scripting

To use for your own scripts, simply add a bang line.

  #!/usr/bin/env ratch

On Windows, of course, you will want to associate the .ratch extension
name to the ratch executable instead.

=== As a Library

To use Ratch as a library, require 'ratch' and create an instance of
Ratch::Shell.

If you wish to extend Ratch::Shell for your application, it is recommend
that you either subclass Ratch::Shell, e.g.

  require 'ratch'

  class MyClass < Ratch::Shell


  end

Or delegate to a Ratch::Shell instance, e.g.

  require 'ratch'

  class MyClass

    def initialize(path)
      @shell = Ratch::Shell.new(path)
    end

  end

For details on all the functionality Ratch provides, please refer to
the API documentation.

== Extras

Ratch also includes the `ludo` command, which stands for "lookup and do".
It will ascend up the directory tree searching for a matching executable 
script. If it finds one it will execute the script relative the currently
ascended directory.


== Installation

Standard installation procedure apply.

  $ gem install ratch

or manually using Setup.rb

  $ tar -xzf ratch-1.0.0.tgz
  $ cd ratch-1.0.0
  $ setup.rb


== Development

You can use gitweb to browse the 'ratch' repository.

To pull the 'ratch' repository anonymously, use:

        git clone git://rubyforge.org/ratch.git
        

Developers: You can push to the 'ratch' repository using:

        git<EMAIL>:ratch.git
        


== Copying

Copyright (c) 2008 <NAME>

Ratch is licensed under the terms of the Apache 2.0 license.
<commit_msg>admin: update README (yeah spellcheck)<commit_after>= Ratch 

Ruby-based Batch Scripts


== Introduction

Ratch is Ruby-based DSL for building batch scripts. It's intent
is to ease the burden of batch script writers by supplementing
the standard ruby environment to be more conducive to the needs
of batch scripting.

In addition to using Ratch to write stand-alone batch scripts,
it makes a very powerful library for other applications that
require batch-like functionality. In general any program that
access the file system extensively could benefit from it's use.


== Resources

* home: http://rubyworks.github.com/ratch
* code: http://github.com/rubyworks/ratch
* talk: http://googlegroups.com/

== Usage

=== Batch Scripting

To use for your own scripts, simply add a bang line.

  #!/usr/bin/env ratch

On Windows, of course, you will want to associate the .ratch extension
name to the ratch executable instead.

=== As a Library

To use Ratch as a library, require 'ratch' and create an instance of
Ratch::Shell.

If you wish to extend Ratch::Shell for your application, it is recommend
that you either subclass Ratch::Shell, e.g.

  require 'ratch'

  class MyClass < Ratch::Shell


  end

Or delegate to a Ratch::Shell instance, e.g.

  require 'ratch'

  class MyClass

    def initialize(path)
      @shell = Ratch::Shell.new(path)
    end

  end

For details on all the functionality Ratch provides, please refer to
the API documentation.


== Bonus Feature

Ratch also includes the `ludo` command, which stands for "lookup and do".
It will ascend up the directory tree searching for a matching executable 
script. If it finds one it will execute the script relative the currently
ascended directory.


== Installation

Standard installation procedure apply.

  $ gem install ratch

or manually using Setup.rb

  $ tar -xzf ratch-1.0.0.tgz
  $ cd ratch-1.0.0
  $ setup.rb


== Development

Ratch is hosted on GitHub.

To pull the 'ratch' repository anonymously, use:

    git clone git://github.com/rubyworks/ratch.git
        

== Copying

Copyright (c) 2008 <NAME>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this program except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


{'fraction_non_alphanumeric': 0.06694473409801877, 'fraction_numerical': 0.005422314911366006, 'mean_word_length': 3.6973555337904016, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4169783', 'n_tokens_mistral': 1421, 'n_tokens_neox': 1327, 'n_words': 647}