## A ruby code format plugin for Sublime Text 2

If you are a ruby programmer, maybe it's useful for you.

With this plugin, it's easy to format ruby code. It can make your ruby code to look beautiful and clearly.

It was rewriten by python code. So it can works fine with out ruby command and faster than using beautiful.rb script.
And also it was independence of the platform.
Hope you use it happily just like the beautiful ruby code.

## Requirement
 Every platform which can run Sublime Text 2, the plugin will work for you.

 It can works on:
- Mac OS X
- Windows
- Linux


## Installation

### Package Control

Using [Package Control](http://wbond.net/sublime_packages/package_control), a package manager for Sublime Text 2.

In Sublime Text 2, press "win(cmd) + shift + p" and then type "install".

Once you see "Package Control: Install Package", enter.

When the packages load, another selection window will appear. 

Type RubyFormat and enter. All done!

### Manual Installation
Open a terminal. change the path to Sublime Text 2 's packages folder.
Then type the command like this:
```bash
  cd "~/Library/Application Support/Sublime Text 2/Packages/"
  git clone git://github.com/zmbacker/RubyFormat.git
```

## Useful

### Key Binding
```
shift + cmd + r on Mac OS X
ctrl + alt + r on Windows
ctrl + alt + r on Linux
```


## TODO List
- Make your ruby code to look more beautiful.



## License
Copyright (C) 2012 Lester Zhao

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.