Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.64 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.64 KB
Raw

melomel.rb -- A Ruby interface to Melomel

DESCRIPTION

Melomel.rb is a library that allows Ruby to communicate with an application running within the Flash virtual machine. For more information on Melomel, visit the GitHub Wiki.

Melomel.rb follows the rules of Semantic Versioning and uses TomDoc for inline documentation.

INSTALLATION

To install Melomel.rb simply use RubyGems:

$ [sudo] gem install melomel

Melomel needs to be embedded and running in the application you're trying to connect to. Please see the Melomel repository for instructions on installation.

HACKING

To get started with working with the source, start by running Bundler to get all your dependencies:

[sudo] bundle install

If you are adding new features, please add test coverage to all code that you write. First compile the Flex application and then run the test suite with rake:

ant
rake test

CONTRIBUTE

If you'd like to contribute to Melomel.rb, please fork the repo on GitHub:

http://github.com/benbjohnson/melomel.rb

To get all of the dependencies, install the gem first. The best way to get your changes merged back into core is as follows:

  1. Clone your fork locally
  2. Create a named topic branch to contain your change
  3. Code
  4. All code must have RSpec test coverage. Run rake to ensure everything passes.
  5. If you are adding new functionality, document it in the README
  6. If necessary, rebase your commits into logical chunks, without errors
  7. Push the branch up to GitHub
  8. Send me a pull request for your branch