Skip to content

Latest commit

 

History

History
146 lines (88 loc) · 2.27 KB

README.md

File metadata and controls

146 lines (88 loc) · 2.27 KB
Raw

Automatic Ruby

Ruby framework for the general-purpose automatic processing

Description

This is a general-purpose automatic processing ruby framework which can extend the functionality by plug-ins.

See doc/README file.

Get Started

[Stable]
$ gem install automatic
$ automatic scaffold
(Make ~/.automatic on your home directory.)
$ automatic -c ~/.automatic/config/example/feed2console.yml
(This process will be output my blog feed to your terminal.)
[Development]
$ git clone git://github.com/automaticruby/automaticruby.git
$ cd automaticruby
$ bundle install --path vendor/gems
$ bin/automatic scaffold
$ bin/automatic -c ~/.automatic/config/example/feed2console.yml
(The same as above.)

Specify any recipe with -c option.

automatic -c <recipe>

Example.

$ automatic -c ~/.automatic/config/example/feed2console.yml

What is Recipe?

Automatic Ruby parses configuration file that was written in the form of YAML which including variety of information of associated plug-ins.

This YAML file is called "Recipe".

You can use -c option for specify a file name.

The Recipe has an implicit naming convention.

plugins:
  - module: MODULE_NAME
    config:
      VARIABLES

For more info, refer to the document (doc/README).

Environment

After Ruby 1.9. See Gemfile.

Development

We need your help.

Repository

Issues

RubyFroge

RubyGems.org

CI

ChangeLog

See doc/ChangeLog file.

Versioning

Releases will be numbered with the follow format:

<year>.<month>

This naming convention is to mimic Ubuntu.

Developers

See doc/AUTHORS or following link.

Project created by

License

Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.

http://www.gnu.org/copyleft/gpl.html

Caution!!! This software is NOT under the terms of the LGPL. See the file doc/COPYING.