Mitten

Description

Mitten is A Ruby IRC Bot Pluggable Framework.

Installation

  • RubyGems

    $ sudo gem install mitten

  • GitHub

    $ git clone http://github.com/Tomohiro/mitten.git

Usage

  1. Usage

    $ ./bin/client -h
$ ./bin/daemon run -- -h

  2. Start

    $ ./bin/daemon start

  3. Restart

    $ ./bin/daemon restart

  4. Stop

    $ ./bin/daemon stop

  5. Changed config file

    $ ./bin/daemon start -- -c lib/environment.yaml

  6. Run on the top(not daemonize)

    $ ./bin/client
$ ./bin/daemon run

Rake tasks

  1. Display Rake tasks

    $ rake -T

  2. Unit Test

    $ rake spec

  3. Generates Rdoc Documentation

    $ rake rdoc

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.

Copyright © 2010 Tomohiro, TAIRA.

Licence

The MIT License. See LICENSE for details.