MacRuby HotCocoa UI library
Ruby
Switch branches/tags
Nothing to show
Pull request Compare This branch is 151 commits behind HotCocoa:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
examples
lib
template
test
.gitignore
.travis.yml
.yardopts
Gemfile
History.txt
README.markdown
Rakefile
hotcocoa.gemspec

README.markdown

hotcocoa

Description

HotCocoa is a thin, idiomatic Ruby layer that sits above Cocoa and other frameworks. HotCocoa used to be included in MacRuby but is now managed as a separate gem. This will allow HotCocoa to accept contributions and evolve more quickly. To see more information on HotCocoa (including tutorial) see http://macruby.org.

Note

This is a fork of HotCocoa that is being kept alive by myself and other contributors; most of the work now is going in to documentation and regression tests, but we are still adding new mappings, improving existing mappings, and adding other features that we feel help meet the goals of this project.

If you find issues with HotCocoa you can open issues and I (or another contributor) will try to fix them.

There are a list of gotchas in the wiki.

Install

  • sudo macrake install

This fork is only available from source right now.

Note: If you are on Snow Leopard, you will also need the Bridge Support Preview in order to run this fork of HotCocoa. Read about it on the MacRuby Blog.

Documentation

Documentation is a work in progress; some of the documentation is being ported from the MacRuby website where it is still available.

The documentation does not include the mappings right now due to the way that mappings are implemented; a YARD plug-in is needed for that.

Contributing to HotCocoa

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
  • No contribution is too small!

License

(The MIT License)

Copyright (c) 2009-2010 Richard Kilmer Copyright (c) 2011 Mark Rada

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.